#文档 #构建 #cargo-docs #cargo-toml #cargo-lock #cli

app cargo-makedocs

仅构建你所关心的文档的 cargo doc 包装器

12 个版本 (3 个稳定版)

1.2.0 2020 年 3 月 16 日
1.1.0 2019 年 6 月 6 日
0.3.2 2019 年 4 月 18 日
0.3.1 2019 年 3 月 17 日
0.1.3 2018 年 11 月 2 日

Cargo 插件 中排名 #692

MIT 许可证

20KB
408

cargo makedocs 构建状态 Crates.io 状态

安装

cargoinstall cargo-makedocs

用法

cargo makedocs 会解析当前工作目录的 Cargo.tomlCargo.lock 文件以查找依赖项,并且只构建直接依赖项的文档。这可以避免你需要输入 cargo doc cargo doc cargo --no-deps cargo -p <crate> ...

选项

如果你想排除一个或多个 crate 以进行文档编制,只需多次传递 -e <cratename>。同样,对于 -,它会在 Cargo.toml 中不包含的情况下对 crate 进行文档编制。

使用 --open 标志将在你的网络浏览器中打开文档(将 --open 传递给 cargo doc)。

相同的 crate 两次

Cargo 不会对重命名的相同 crate 进行两次文档编制,即使你已经将其重命名。这意味着你无法获取 futures 0.1 和 0.3 的文档。要解决这个问题,只需使用 - 标志。

cargo makedocs -e futures01 # assuming futures 0.1 is named futures01

许可证

cargo-makedocs 在 MIT 许可证下提供,有关更多详细信息,请参阅 LICENSE。

依赖项

~1.3–2MB
~36K SLoC