Skip to content
Tool to generate docsets (Dash/Zeal/etc.) for Rust crates
Rust
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
Cargo.lock
Cargo.toml
LICENSE-APACHE
LICENSE-MIT
README.md
dashing.json

README.md

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 generated <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.

You can’t perform that action at this time.