| Build a package's documentation, using specified custom flags. |
| |
| Usage: cargo[EXE] rustdoc [OPTIONS] [ARGS]... |
| |
| Arguments: |
| [ARGS]... Extra rustdoc flags |
| |
| Options: |
| --open Opens the docs in a browser after the operation |
| --ignore-rust-version Ignore `rust-version` specification in packages |
| --message-format <FMT> Error format |
| --output-format <FMT> The output type to write (unstable) [possible values: html, json] |
| -v, --verbose... Use verbose output (-vv very verbose/build.rs output) |
| -q, --quiet Do not print cargo log messages |
| --color <WHEN> Coloring: auto, always, never |
| --config <KEY=VALUE> Override a configuration value |
| -Z <FLAG> Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for |
| details |
| -h, --help Print help |
| |
| Package Selection: |
| -p, --package [<SPEC>] Package to document |
| |
| Target Selection: |
| --lib Build only this package's library |
| --bins Build all binaries |
| --bin [<NAME>] Build only the specified binary |
| --examples Build all examples |
| --example [<NAME>] Build only the specified example |
| --tests Build all test targets |
| --test [<NAME>] Build only the specified test target |
| --benches Build all bench targets |
| --bench [<NAME>] Build only the specified bench target |
| --all-targets Build all targets |
| |
| Feature Selection: |
| -F, --features <FEATURES> Space or comma separated list of features to activate |
| --all-features Activate all available features |
| --no-default-features Do not activate the `default` feature |
| |
| Compilation Options: |
| -j, --jobs <N> Number of parallel jobs, defaults to # of CPUs. |
| --keep-going Do not abort the build as soon as there is an error |
| -r, --release Build artifacts in release mode, with optimizations |
| --profile <PROFILE-NAME> Build artifacts with the specified profile |
| --target [<TRIPLE>] Build for the target triple |
| --target-dir <DIRECTORY> Directory for all generated artifacts |
| --unit-graph Output build graph in JSON (unstable) |
| --timings[=<FMTS>] Timing output formats (unstable) (comma separated): html, json |
| |
| Manifest Options: |
| --manifest-path <PATH> Path to Cargo.toml |
| --frozen Require Cargo.lock and cache are up to date |
| --locked Require Cargo.lock is up to date |
| --offline Run without accessing the network |
| |
| Run `cargo help rustdoc` for more detailed information. |
