rsdocs-dashing

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

APACHE-2.0 License

Downloads

1.3K

Stars

17

Committers

View Code on GitHub View on X

Ecosystems: Rust

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

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.

Package Rankings

Top 32.64% on Crates.io

Related Projects

rust-digger

rustwide

Execute your code on the Rust ecosystem.

22 Aug 2019 182

databind

Expand the functionality of Minecraft Datapacks.

rust-service-template

rustdoc-types

Rustdoc's JSON output interface

cc-rs

Rust library for build scripts to compile C/C++ code into a Rust library

01 Nov 2014 1,832

rust-gh-example

An example project that uses Rust GitHub template

rustdoc-index

A fast listing tool for rustdoc

rust-demo-dependency-injection

A demo project showing dependency injection approaches

rust-template-rs

Misc Rust templates for use with `cargo-generate`

rustdoc-prettier

Format //! and /// comments with prettier

ronat

Rust linter for documentation

cargo-generate

cargo, make me a project

29 May 2018 1,941

docs.rs

crates.io documentation generator

26 Jan 2016 979

vectora

A Rust library for n-dimensional vector computation with real and complex scalar data