cargo-docs

本地提供 Rust 和 crate 文档的 Cargo 插件。

$ cargo docs --help
Usage: cargo docs [OPTIONS] [EXTRA_ARGS]...

Arguments:
  [EXTRA_ARGS]...  Passthrough extra args to `cargo doc`

Options:
      --host <HOST>                    Set host [env: HOST=] [default: 127.0.0.1]
  -p, --port <PORT>                    Set port [env: PORT=] [default: 8080]
  -r, --random-port                    Use random port [env: CARGO_DOCS_RANDOM_PORT=true]
  -s, --search <ITEM>                  Search for item
  -d, --dir <DIR>                      Serve directory content [env: DIR=]
  -c, --manifest-path <MANIFEST_PATH>  Crate manifest path [default: Cargo.toml]
  -w, --watch                          Re-generate doc on change [env: CARGO_DOCS_WATCH=]
  -o, --open                           Open in browser [env: CARGO_DOCS_OPEN=true]
  -b, --book                           Serve rust book and std doc instead
  -h, --help                           Print help information
  -V, --version                        Print version information

默认情况下，它将调用 cargo doc 来构建 crate 文档并启动本地服务器。

添加 --book 选项以查看 Rust 文档。

安装

$ cargo install cargo-docs

示例

在随机端口上提供 crate 文档并在浏览器中打开

$ cargo docs -ro
[INFO] Serving crate doc on http://127.0.0.1:45669
[INFO] Opening http://127.0.0.1:45669

与上面相同，并且会在文件更改时自动重建和重新加载。

$ cargo docs -row
[INFO] Listening for changes...
[INFO] Serving crate doc on http://127.0.0.1:45669
[INFO] Opening http://127.0.0.1:45669

提供 Rust 文档（大致等同于 cargo-book）

$ cargo docs -bro
[INFO] Serving rust doc on http://127.0.0.1:46661
[INFO] Opening http://127.0.0.1:46661

在随机端口上提供的 Rust std 文档中搜索 SocketAddr 并在浏览器中打开它

$ cargo docs -bros SocketAddr
[INFO] Serving rust doc on http://127.0.0.1:40143
[INFO] Opening http://127.0.0.1:40143/std/?search=SocketAddr

专业技巧

在 -- 后传递 cargo doc 选项

$ cargo docs -- --quiet
[INFO] Running cargo doc --quiet
[INFO] Serving crate doc on http://127.0.0.1:8080

如果你在使用 WSL2，将环境变量 BROWSER=/mnt/c/Path/To/Your/Browser.exe 设置为在桌面浏览器中打开

$ export BROWSER="/mnt/c/Program Files/Firefox Nightly/firefox.exe"

厌倦了输入 -o、-ro、-row？尝试这些环境变量来节省一些按键。

$ export CARGO_DOCS_OPEN=true
$ export CARGO_DOCS_WATCH=true
$ export CARGO_DOCS_RANDOM_PORT=true