cargo-docs

A cargo plugin for serving rust and crate doc locally.

``` $ cargo docs --help cargo-docs-docs

USAGE: cargo-docs docs [OPTIONS] [EXTRA_ARGS]...

ARGS: ... Passthrough extra args to cargo doc

OPTIONS: -b, --book Serve rust book and std doc instead -c, --manifest-path Crate manifest path [default: Cargo.toml] -d, --dir

Serve directory content [env: DIR=] -h, --help Print help information --host Set host [env: HOST=] [default: 127.0.0.1] -o, --open Open in browser -p, --port Set port [env: PORT=] [default: 8080] -r, --random-port Use random port -w, --watch Re-generate doc on change TODO: unimplemented ```

By default, it will call cargo doc to build crate doc and start a local server.

Add --book option to see rust doc instead.

Install

$ cargo install cargo-docs

Examples

Serve crate doc on random port and open in browser
If you are on WSL2, set BROWSER=/mnt/c/Path/To/Your/Browser.exe environment variable to open in desktop browser $ cargo docs -ro Serving crate doc on http://127.0.0.1:45669 Opening http://127.0.0.1:45669

Serve rust doc (effectively the same as cargo-book) on random port and open in browser $ cargo docs -bro Serving rust doc on http://127.0.0.1:46661 Opening http://127.0.0.1:46661

Search for SocketAddr in rust std doc served on random port and open it in browser $ cargo docs -bros SocketAddr Serving rust doc on http://127.0.0.1:40143 Opening http://127.0.0.1:40143/std/?search=SocketAddr

Passthrough cargo doc options after -- $ cargo docs -p 8080 -- --quiet Serving crate doc on http://127.0.0.1:8080

Set host, port using HOST, PORT environment variable $ HOST=0.0.0.0 PORT=3333 cargo docs Serving crate doc on http://0.0.0.0:3333

Serve current directory content on 0.0.0.0:8910 (listing is not supported yet) $ cargo docs -d . --host 0.0.0.0 --port 8910 Serving . on http://0.0.0.0:8910

Serve files under ./target/doc $ DIR=./target/doc cargo docs Serving ./target/doc on http://127.0.0.1:8080