cargo-docset - Generate a Zeal/Dash docset for your Rust crate or workspace
cargo-docset depends on the SQLite3 library. You can either install the SQLite3 library on your system (see
rusqlite's documentation for
help), or build the version that is bundled in the
libsqlite3-sys crate by turning on the
flag when building
You can install cargo docset with the usual cargo command:
cargo install cargo-docset.
How to use
cargo docset in your crate's directory to generate the docset. It will be placed in the
directory. cargo-docset generally supports the same options as
cargo doc, with a few additional ones. Run
cargo docset --help for more information.
To install your shiny new docset, copy it to your Zeal/Dash docset directory (available in the preferences, on Zeal at least) and restart Zeal/Dash.
How it works
cargo docset runs
cargo to generate the documentation, and then recursively walks the generated
directory. The contents of every file is inferred from the file path, and cargo-docset then fills a SQLite database with
the gathered information. The details of docset generation are available here.
cargo-docset does not (yet, at least) try to parse the generated documentation in any way, and therefore is limited in
the granularity of the index it can provide. In particular, the generated docset does not make use of the table of
cargo-docset walks through the whole
doc directory, it must clear it before attempting to generate
the docset, in case there is some previously generated documentation that we don't want to pickup in the docset there.
You should probably not be storing anything of value in that directory anyway, but keep it in mind.