cargo-ghdoc

从github PR中启动cargo docs。

此工具旨在作为在Rust项目中审查PR时的辅助工具。在渲染之前很难知道文档会是什么样子。在没有看到文档的情况下，也难以获得PR的上下文。此工具通过一条命令解决了这两个问题。

安装

cargo install cargo-ghdoc

用法

在github的开放PR页面中，复制页眉的URL。然后运行以下命令，将此处URL替换为您的开放PR。

cargo ghdoc https://github.com/fulcrumgenomics/cargo-ghdoc/pull/1

这将打开从该PR的签出中Rust项目的Rust文档。

开始挑刺。

实现说明

此工具只是在底层运行git和cargo shell。因此，这两个二进制文件应在您的路径中可找到。此外，此工具要求您已设置SSH凭证，并且它们对于相关仓库是有效的。

等效shell命令

mkdir <tempdir>
cd <tempdir>
git clone <repo>
cd <repo>
git fetch origin pull/<PR number>/head:GHDOC
git checkout GHDOC
cargo doc --open

由于此工具依赖于git，您必须拥有足够的权限来运行这些命令。