https://github.com/hobofan/rsdocs-dashing

Tool to generate docsets (Dash/Zeal/etc.) for Rust crates
https://github.com/hobofan/rsdocs-dashing

Last synced: 22 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/hobofan/rsdocs-dashing
• Owner: hobofan
• License: apache-2.0
• Created: 2017-06-20T21:16:52.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-04T10:04:10.000Z (over 5 years ago)
• Last Synced: 2024-09-15T20:59:48.308Z (about 2 months ago)
• Language: Rust
• Homepage:
• Size: 9.77 KB
• Stars: 17
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
## Tool to generate a `dashing.json` for generating docsets for your crate/project

### Installation

The CLI can be installed via:

```bash

cargo install rsdocs-dashing

```

### Usage

Given that you crate is named ``:

- Generate the cargo documentation for the crate via `cargo doc` (add feature flags if desired)

- Run `rsdocs-dashing target/doc/ docset`

- Run `dashing build --config docset/dashing.json --source docset/build`

- Add the newly generated `.docset` to your docset viewer

### License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

#### Alternatives

Pure Rust approach that does some more heavy lifting: [rsdocs2docset](https://github.com/kesselborn/rsdocs2docset).

Python approach: [rust-docset](https://github.com/vhbit/rust-docset).