cargo-makedocs
| Crates.io | cargo-makedocs |
| lib.rs | cargo-makedocs |
| version | 1.2.0 |
| created_at | 2018-11-01 20:47:12.087348+00 |
| updated_at | 2020-03-16 22:27:49.911229+00 |
| description | A cargo doc wrapper that only builds the documentation you care about |
| homepage | |
| repository | https://github.com/Bunogi/cargo-makedocs |
| max_upload_size | |
| id | 94085 |
| size | 29,606 |
Håkon Jordet (Bunogi)
documentation
README
cargo makedocs 
Installation
cargo install cargo-makedocs
Usage
cargo makedocs will parse your current working directory's Cargo.toml and Cargo.lock for dependencies, and only build documentation for the direct dependencies. This saves you from having to type cargo doc --no-deps -p <crate> ....
Options
If you want to exclude one or more crates for being documented, simply pass -e <cratename> as many times as needed. Same goes in reverse for -i, which will document a crate even if it isn't part of your Cargo.toml.
The --open flag will open the documentation in your web browser(passes --open to cargo doc).
Same (renamed) crate twice
Cargo will not document the same crate twice even if you have renamed it. This means that you can't, for example, get the documentation for both futures 0.1 and 0.3. To resolve such a situation, simply use the -e flag:
cargo makedocs -e futures01 # assuming futures 0.1 is named futures01
License
cargo-makedocs is available under the MIT license, see LICENSE for more details.