cargo-docs

A cargo plugin for serving rust and crate doc locally.

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

Add --book option to see rust doc instead.

Examples

Serve crate doc on local port 8080

$ cargo docs -p 8080
Serving crate doc on http://127.0.0.1:8080

Set host, port using HOST, PORT environment variable

$ cargo docs -p 8080
$ HOST=0.0.0.0 PORT=3333 cargo docs
Serving crate doc on http://0.0.0.0:3333

Passthrough cargo doc options after --

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

Serve rust doc (effectively the same as cargo-book

$ cargo docs --book
Serving rust doc on http://127.0.0.1:8080

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