#docset #generate #json #order #prepare #dashing #docsets

app rsdocs-dashing

为生成docsets准备rsdocs的工具

1 个不稳定版本

使用旧的Rust 2015

0.1.0 2017年8月15日

#3 in #prepare

MIT/Apache

7KB
78 代码行

生成用于生成你的crate/项目的docsets的dashing.json的工具

安装

可以通过以下方式安装CLI

cargo install rsdocs-dashing

用法

假设你的crate名为 <MYCRATE>

  • 通过 cargo doc(如果需要,添加功能标志)生成crate的cargo文档
  • 运行 rsdocs-dashing target/doc/<MYCRATE> docset
  • 运行 dashing build --config docset/dashing.json --source docset/build
  • 将新生成的 docset/<MYCRATE>.docset 添加到你的docset查看器中

许可证

在以下任一许可证下授权:

由你选择。

替代方案

纯Rust方法,执行更多重任务:rsdocs2docset。Python方法:rust-docset

依赖关系

~4–12MB
~148K SLoC