Lib.rs

Tool to generate a dashing.json for generating docsets for your crate/project

Installation

The CLI can be installed via:

cargo install rsdocs-dashing

Usage

Given that you crate is named <MYCRATE>:

• Generate the cargo documentation for the crate via cargo doc (add feature flags if desired)
• Run rsdocs-dashing target/doc/<MYCRATE> docset
• Run dashing build --config docset/dashing.json --source docset/build
• Add the newly generate docset/<MYCRATE>.docset to your docset viewer

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Alternatives

Pure Rust approach that does some more heavy lifting: rsdocs2docset. Python approach: rust-docset.