cargo-rustdoc --- Build a package's documentation, using specified custom flags
cargo rustdoc
[options] [--
args]
The specified target for the current package (or package specified by -p
if provided) will be documented with the specified args being passed to the final rustdoc invocation. Dependencies will not be documented as part of this command. Note that rustdoc will still unconditionally receive arguments such as -L
, --extern
, and --crate-type
, and the specified args will simply be added to the rustdoc invocation.
See https://doc.rust-lang.org/rustdoc/index.html for documentation on rustdoc flags.
This command requires that only one target is being compiled when additional arguments are provided. If more than one target is available for the current package the filters of --lib
, --bin
, etc, must be used to select which target is compiled.
To pass flags to all rustdoc processes spawned by Cargo, use the RUSTDOCFLAGS
environment variable or the build.rustdocflags
config value.
By default, the package in the current working directory is selected. The -p
flag can be used to choose a different package in a workspace.
When no target selection options are given, cargo rustdoc
will document all binary and library targets of the selected package. The binary will be skipped if its name is the same as the lib target. Binaries are skipped if they have required-features
that are missing.
Passing target selection flags will document only the specified targets.
Note that --bin
, --example
, --test
and --bench
flags also support common Unix glob patterns like *
, ?
and []
. However, to avoid your shell accidentally expanding glob patterns before Cargo handles them, you must use single quotes or double quotes around each glob pattern.
The feature flags allow you to control which features are enabled. When no feature options are given, the default
feature is activated for every selected package.
See the features documentation for more details.
See the reference for details on environment variables that Cargo reads.
0
: Cargo succeeded.101
: Cargo failed to complete.Build documentation with custom CSS included from a given file:
cargo rustdoc --lib -- --extend-css extra.css