cargo-rustdoc

Build docs with rustdoc options

$ cargo rustdoc -- [rustdoc_flags]

$ cargo rustdoc -- --document-private-items

$ cargo rustdoc -Z unstable-options --output-format json

$ cargo rustdoc --bin [name] -- [flags]

$ cargo rustdoc --all-features

cargo rustdoc [options] [-- args]

cargo rustdoc builds documentation for the current package and passes extra options directly to the rustdoc tool. Arguments after `--` are forwarded only to the final rustdoc invocation for the specified target, not to dependencies.
This command is similar to `cargo doc` but provides fine-grained control over rustdoc flags. Common uses include documenting private items, generating JSON output for tooling (on nightly), and passing custom HTML or CSS settings. Only one target can be documented at a time when extra arguments are provided.

--open

Open docs in browser after building

Document library only

Document specified binary

Document all binaries

Document specified example

Document all examples

Package to document

Document for target platform

Parallel jobs

Enable features

Enable all features

Disable default features

html

HTML documentation (default)

JSON format (nightly, experimental)

Only one target can be documented when passing extra arguments. Use target filters to select.

cargo(1), cargo-doc(1), rustdoc(1)