cargo-doc - Build a package's documentation
cargo doc [OPTIONS]
Build the documentation for the local package and all dependencies. The output
is placed in
target/doc in rustdoc’s usual format.
Open the docs in a browser after building them.
Do not build documentation for dependencies.
Include non-public items in the documentation.
By default, when no package selection options are given, the packages selected
depend on the current working directory. In the root of a virtual workspace,
all workspace members are selected (
--all is implied). Otherwise, only the
package in the current directory will be selected. The default packages may be
overridden with the
workspace.default-members key in the root
- -p SPEC…
- --package SPEC…
Document only the specified packages. See cargo-pkgid(1) for the SPEC format. This flag may be specified multiple times.
Document all members in the workspace.
- --exclude SPEC…
Exclude the specified packages. Must be used in conjunction with the
--allflag. This flag may be specified multiple times.
When no target selection options are given,
cargo doc 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.
The default behavior can be changed by setting
doc = false for the target in
the manifest settings. Using target selection options will ignore the
flag and will always document the given target.
Document the package’s library.
- --bin NAME…
Document the specified binary. This flag may be specified multiple times.
Document all binary targets.
When no feature options are given, the
default feature is activated for
every selected package.
- --features FEATURES
Space or comma separated list of features to activate. These features only apply to the current directory’s package. Features of direct dependencies may be enabled with
Activate all available features of all selected packages.
Do not activate the
defaultfeature of the current directory’s package.
- --target TRIPLE
Document for the given architecture. The default is the host architecture. The general format of the triple is
rustc --print target-listfor a list of supported targets.
This may also be specified with the
Document optimized artifacts with the
releaseprofile. See the PROFILES section for details on how this affects profile selection.
- --target-dir DIRECTORY
Directory for all generated artifacts and intermediate files. May also be specified with the
CARGO_TARGET_DIRenvironment variable, or the
build.target-dirconfig value. Defaults to
targetin the root of the workspace.
Use verbose output. May be specified twice for "very verbose" output which includes extra output such as dependency warnings and build script output. May also be specified with the
No output printed to stdout.
- --color WHEN
Control when colored output is used. Valid values:
auto(default): Automatically detect if color support is available on the terminal.
always: Always display colors.
never: Never display colors.
May also be specified with the
- --message-format FMT
The output format for diagnostic messages. Valid values:
human(default): Display in a human-readable text format.
json: Emit JSON messages to stdout.
short: Emit shorter, human-readable text messages.
- --manifest-path PATH
Path to the
Cargo.tomlfile. By default, Cargo searches in the current directory or any parent directory for the
Either of these flags requires that the
Cargo.lockfile is up-to-date. If the lock file is missing, or it needs to be updated, Cargo will exit with an error. The
--frozenflag also prevents Cargo from attempting to access the network to determine if it is out-of-date.
These may be used in environments where you want to assert that the
Cargo.lockfile is up-to-date (such as a CI build) or want to avoid network access.
Prevents Cargo from accessing the network for any reason. Without this flag, Cargo will stop with an error if it needs to access the network and the network is not available. With this flag, Cargo will attempt to proceed without the network if possible.
Beware that this may result in different dependency resolution than online mode. Cargo will restrict itself to crates that are downloaded locally, even if there might be a newer version as indicated in the local copy of the index. See the cargo-fetch(1) command to download dependencies before going offline.
May also be specified with the
Prints help information.
- -Z FLAG…
Unstable (nightly-only) flags to Cargo. Run
cargo -Z helpfor details.
- -j N
- --jobs N
Number of parallel jobs to run. May also be specified with the
build.jobsconfig value. Defaults to the number of CPUs.
Profiles may be used to configure compiler options such as optimization levels and debug settings. See the reference for more details.
Profile selection depends on the target and crate being built. By default the
test profiles are used. If the
--release flag is given, then the
bench profiles are used.
lib, bin, example
test, bench, or any target
Dependencies use the
See the reference for details on environment variables that Cargo reads.
Cargo failed to complete.
Build the local package documentation and its dependencies and output to