cargo rustdoc <args...>

Build a package's documentation, using specified custom flags

Arguments

NameDescription
args

Options

NameDescription
-p, --package <package...>Package to document
-j, --jobs <jobs>Number of parallel jobs, defaults to # of CPUs
--bin <bin...>
  • Repeatable ♾
--example <example...>
  • Repeatable ♾
--test <test...>
  • Repeatable ♾
--bench <bench...>
  • Repeatable ♾
--profile <profile>Build artifacts with the specified profile
--features <features...>
  • Repeatable ♾
--target <target>
  • Repeatable ♾
--target-dir <target-dir>Directory for all generated artifacts
--manifest-path <manifest-path>Path to Cargo.toml
--message-format <message-format>
  • Repeatable ♾
--color <color>Coloring: auto, always, never
--config <config>
  • Repeatable ♾
-Z <unstable-features>
  • Repeatable ♾
-q, --quietDo not print cargo log messages
--openOpens the docs in a browser after the operation
--libBuild only this package's library
--binsBuild all binaries
--examplesBuild all examples
--testsBuild all tests
--benchesBuild all benches
--all-targetsBuild all targets
-r, --releaseBuild artifacts in release mode, with optimizations
--all-featuresActivate all available features
--no-default-featuresDo not activate the `default` feature
--unit-graphOutput build graph in JSON (unstable)
--ignore-rust-versionIgnore `rust-version` specification in packages
-h, --helpPrint help information
-v, --verbose
  • Repeatable ♾
--frozenRequire Cargo.lock and cache are up to date
--lockedRequire Cargo.lock is up to date
--offlineRun without accessing the network
--timingsTiming output formats (unstable)