Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.

About

Tool to generate docsets (Dash/Zeal/etc.) for Rust crates

Resources

License

Packages

No packages published

Languages