#docset #dashing

app rsdocs-dashing

Tool to prepare rsdocs for dashing, in order to generate docsets

1 unstable release

Uses old Rust 2015

0.1.0 Aug 15, 2017

MIT/Apache

7KB
78 lines

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

at your option.

Alternatives

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

Dependencies

~5.5MB
~112K SLoC