1 unstable release

0.1.0 Nov 6, 2020

#5 in #literate

23 downloads per month
Used in cargo-docco

MIT/Apache and GPL-3.0 licenses

38KB
238 lines

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.

Dependencies

~12MB
~207K SLoC