rocco

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2020 License: Apache-2.0, MIT

README

Build Status crates.io docs.rs license license

Rocco

Rocco (library) is a Rust port of Jash Kenas' docco. A way to achieve literate programming.

Overview

Rocco is primarily in use by cargo-docco. It provides APIs to generate documentation from literate source files. (see languages.json for supported languages). Feel free to submit PRs to support more languages.

Literate programming style docs are supported only as line comments. Block comments are usually not supported (for keeping implementation concise and simple), as in the original implementation.

Support

Buy Me A Coffee

ko-fi

License

Dual licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Directories

Path Synopsis
tests
samples
**Gocco** is a Go port of [Docco](http://jashkenas.github.com/docco/): the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
**Gocco** is a Go port of [Docco](http://jashkenas.github.com/docco/): the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL