cargo doc
Build a package's documentation
Options
Name | Description |
---|---|
-p, --package <package...> |
|
--exclude <exclude> |
|
-j, --jobs <jobs> | Number of parallel jobs, defaults to # of CPUs |
--bin <bin...> |
|
--example <example...> |
|
--profile <profile> | Build artifacts with the specified profile |
--features <features...> |
|
--target <target> |
|
--target-dir <target-dir> | Directory for all generated artifacts |
--manifest-path <manifest-path> | Path to Cargo.toml |
--message-format <message-format> |
|
--color <color> | Coloring: auto, always, never |
--config <config> |
|
-Z <unstable-features> |
|
-q, --quiet | Do not print cargo log messages |
--open | Opens the docs in a browser after the operation |
--workspace | Document all packages in the workspace |
--all | Alias for --workspace (deprecated) |
--no-deps | Don't build documentation for dependencies |
--document-private-items | Document private items |
--lib | Document only this package's library |
--bins | Document all binaries |
--examples | Document all examples |
-r, --release | Build artifacts in release mode, with optimizations |
--all-features | Activate all available features |
--no-default-features | Do not activate the `default` feature |
--ignore-rust-version | Ignore `rust-version` specification in packages |
--unit-graph | Output build graph in JSON (unstable) |
-h, --help | Print help information |
-v, --verbose |
|
--frozen | Require Cargo.lock and cache are up to date |
--locked | Require Cargo.lock is up to date |
--offline | Run without accessing the network |
--timings | Timing output formats (unstable) |