CARGO-RUSTDOC(1)

📦 version 1.78.0, in ubuntu jammy, ubuntu noble

💅 cargo-rustdoc

hiii bestie, this is the manual page for cargo-rustdoc, straight outta the General Commands Manual (section 1). it's giving "build your docs, but make it custom." let's get into it ✨

🌸 NAME

cargo-rustdoc — build a package's documentation, using specified custom flags 💖

✨ SYNOPSIS

cargo rustdoc [options] [-- args]

🦋 DESCRIPTION

okay so. the target you picked for the current package (or the package you named with -p if you provided it) gets documented, and whatever you put in args gets passed straight into the final rustdoc invocation. dependencies do NOT get documented as part of this command — not their moment, not their era. 🙈

but real talk: rustdoc still unconditionally receives arguments like -L, --extern, and --crate-type, and your specified args just get added to the rustdoc invocation on top of that. 💅

for the full tea on rustdoc flags, go read https://doc.rust-lang.org/rustdoc/index.html 🫶

also!! this command requires that only one target is being compiled when you pass additional arguments. if more than one target is available for the current package, you must use the filters --lib, --bin, etc. to select which target gets compiled. pick a lane, queen 👑

and if you want flags passed to every single rustdoc process spawned by Cargo, use the RUSTDOCFLAGS environment variable (https://doc.rust-lang.org/cargo/reference/environment-variables.html) or the build.rustdocflags config value (https://doc.rust-lang.org/cargo/reference/config.html). 🌈

💅 OPTIONS

🎀 Documentation Options

📦 Package Selection

by default, the package in the current working directory is the chosen one. the -p flag lets you pick a different package in a workspace. main character swap ✨

  • -p spec, --package spec — the package to document. see cargo-pkgid(1) for the SPEC format. iykyk 💜

🎯 Target Selection

when you give no target selection options, cargo rustdoc will document all binary and library targets of the selected package. the binary gets skipped if its name is the same as the lib target. and binaries get skipped if they have required-features that are missing. 💀

passing target selection flags means only the specified targets get documented. periodt.

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. no cap, this one bites people 🚨
  • --lib — document the package's library.
  • --bin name… — document the specified binary. this flag may be specified multiple times and supports common Unix glob patterns.
  • --bins — document all binary targets.
  • --example name… — document the specified example. this flag may be specified multiple times and supports common Unix glob patterns.
  • --examples — document all example targets.
  • --test name… — document the specified integration test. this flag may be specified multiple times and supports common Unix glob patterns.
  • --tests — document all targets in test mode that have the test = true manifest flag set. by default this includes the library and binaries built as unittests, and integration tests. be aware that this will also build any required dependencies, so the lib target may be built twice (once as a unittest, and once as a dependency for binaries, integration tests, etc.). targets may be enabled or disabled by setting the test flag in the manifest settings for the target.
  • --bench name… — document the specified benchmark. this flag may be specified multiple times and supports common Unix glob patterns.
  • --benches — document all targets in benchmark mode that have the bench = true manifest flag set. by default this includes the library and binaries built as benchmarks, and bench targets. be aware that this will also build any required dependencies, so the lib target may be built twice (once as a benchmark, and once as a dependency for binaries, benchmarks, etc.). targets may be enabled or disabled by setting the bench flag in the manifest settings for the target.
  • --all-targets — document all targets. this is equivalent to specifying --lib --bins --tests --benches --examples. it ate, honestly 🔥

🌸 Feature Selection

the feature flags let you control which features are enabled. when no feature options are given, the default feature is activated for every selected package. ✨

see the features documentation at https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options for more details.

  • -F features, --features features — space or comma separated list of features to activate. features of workspace members may be enabled with package-name/feature-name syntax. this flag may be specified multiple times, which enables all specified features.
  • --all-features — activate all available features of all selected packages. go big or go home 💅
  • --no-default-features — do not activate the default feature of the selected packages.

🔧 Compilation Options

  • --target triple — document for the given architecture. the default is the host architecture. the general format of the triple is <arch><sub>-<vendor>-<sys>-<abi>. run rustc --print target-list for a list of supported targets. this flag may be specified multiple times.

this may also be specified with the build.target config value (https://doc.rust-lang.org/cargo/reference/config.html).

note that specifying this flag makes Cargo run in a different mode where the target artifacts are placed in a separate directory. see the build cache documentation (https://doc.rust-lang.org/cargo/guide/build-cache.html) for more details.

  • -r, --release — document optimized artifacts with the release profile. see also the --profile option for choosing a specific profile by name.
  • --profile name — document with the given profile. see the reference (https://doc.rust-lang.org/cargo/reference/profiles.html) for more details on profiles.
  • --ignore-rust-version — document the target even if the selected Rust compiler is older than the required Rust version as configured in the project's rust-version field. breaking the rules, respectfully 🫶
  • --timings=fmts — output information about how long each compilation takes, and track concurrency information over time. accepts an optional comma-separated list of output formats; --timings without an argument will default to --timings=html. specifying an output format (rather than the default) is unstable and requires -Zunstable-options. valid output formats:
    • html (unstable, requires -Zunstable-options): write a human-readable file cargo-timing.html to the target/cargo-timings directory with a report of the compilation. also write a report to the same directory with a timestamp in the filename if you want to look at older runs. HTML output is suitable for human consumption only, and does not provide machine-readable timing data.
    • json (unstable, requires -Zunstable-options): emit machine-readable JSON information about timing information.

📁 Output Options

  • --target-dir directory — directory for all generated artifacts and intermediate files. may also be specified with the CARGO_TARGET_DIR environment variable, or the build.target-dir config value (https://doc.rust-lang.org/cargo/reference/config.html). defaults to target in the root of the workspace. 🎀

👀 Display Options

  • -v, --verbose — 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 term.verbose config value (https://doc.rust-lang.org/cargo/reference/config.html).
  • -q, --quiet — do not print cargo log messages. may also be specified with the term.quiet config value (https://doc.rust-lang.org/cargo/reference/config.html). shhh 🤫
  • --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 term.color config value (https://doc.rust-lang.org/cargo/reference/config.html).

  • --message-format fmt — the output format for diagnostic messages. can be specified multiple times and consists of comma-separated values. valid values:
    • human (default): display in a human-readable text format. conflicts with short and json.
    • short: emit shorter, human-readable text messages. conflicts with human and json.
    • json: emit JSON messages to stdout. see the reference (https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages) for more details. conflicts with human and short.
    • json-diagnostic-short: ensure the rendered field of JSON messages contains the "short" rendering from rustc. cannot be used with human or short.
    • json-diagnostic-rendered-ansi: ensure the rendered field of JSON messages contains embedded ANSI color codes for respecting rustc's default color scheme. cannot be used with human or short.
    • json-render-diagnostics: instruct Cargo to not include rustc diagnostics in JSON messages printed, but instead Cargo itself should render the JSON diagnostics coming from rustc. Cargo's own JSON diagnostics and others coming from rustc are still emitted. cannot be used with human or short.

📜 Manifest Options

  • --manifest-path path — path to the Cargo.toml file. by default, Cargo searches for the Cargo.toml file in the current directory or any parent directory.
  • --frozen, --locked — either of these flags requires that the Cargo.lock file is up-to-date. if the lock file is missing, or it needs to be updated, Cargo will exit with an error. the --frozen flag 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.lock file is up-to-date (such as a CI build) or want to avoid network access.

  • --offline — 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. airplane mode but make it compile ✈️

okay that's the first half bestie, keep scrolling, there's more where that came from 👇

Bestie, beware — this can give you 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. ✨ plan ahead, queen ✨

May also be specified with the net.offline config value https://doc.rust-lang.org/cargo/reference/config.html.

🛠️ Common Options 🛠️

  • +toolchain — if Cargo has been installed with rustup, and the first argument to cargo begins with +, it will be interpreted as a rustup toolchain name (such as +stable or +nightly). See the rustup documentation https://rust-lang.github.io/rustup/overrides.html for more information about how toolchain overrides work. tl;dr: pick your toolchain, pick your era 💅
  • --config KEY=VALUE or PATH — overrides a Cargo configuration value. The argument should be in TOML syntax of KEY=VALUE, or provided as a path to an extra configuration file. This flag may be specified multiple times. See the command-line overrides section https://doc.rust-lang.org/cargo/reference/config.html#command-line-overrides for more information.
  • -C PATH — changes the current working directory before executing any specified operations. This affects things like where cargo looks by default for the project manifest (Cargo.toml), as well as the directories searched for discovering .cargo/config.toml, for example. This option must appear before the command name, for example cargo -C path/to/my-project build. order matters, bestie, don't test me 🙈

This option is only available on the nightly channel https://doc.rust-lang.org/book/appendix-07-nightly-rust.html and requires the -Z unstable-options flag to enable (see #10098 https://github.com/rust-lang/cargo/issues/10098).

  • -h, --help — prints help information. when in doubt, ask for help 💖
  • -Z flag — unstable (nightly-only) flags to Cargo. Run cargo -Z help for details.

🌈 Miscellaneous Options 🌈

  • -j N, --jobs N — number of parallel jobs to run. May also be specified with the build.jobs config value https://doc.rust-lang.org/cargo/reference/config.html. Defaults to the number of logical CPUs. If negative, it sets the maximum number of parallel jobs to the number of logical CPUs plus provided value. If a string default is provided, it sets the value back to defaults. Should not be 0. zero jobs is not a vibe, it's a paradox 😭
  • --keep-going — build as many crates in the dependency graph as possible, rather than aborting the build on the first one that fails to build. resilience era ✨

For example if the current package depends on dependencies fails and works, one of which fails to build, cargo rustdoc -j1 may or may not build the one that succeeds (depending on which one of the two builds Cargo picked to run first), whereas cargo rustdoc -j1 --keep-going would definitely run both builds, even if the one run first fails.

This option is only available on the nightly channel https://doc.rust-lang.org/book/appendix-07-nightly-rust.html and requires the -Z unstable-options flag to enable.

🌱 ENVIRONMENT 🌱

See the reference https://doc.rust-lang.org/cargo/reference/environment-variables.html for details on environment variables that Cargo reads. yes, it reads the vibes you set in your shell 🫶

💀 EXIT STATUS 💀

  • 0 — Cargo succeeded. we love a win 🎀
  • 101 — Cargo failed to complete. oof. it's giving tragedy 😭

🦋 EXAMPLES 🦋

  1. Build documentation with custom CSS included from a given file:
cargo rustdoc --lib -- --extend-css extra.css

custom css? serving looks, literally 👑

🌸 SEE ALSO 🌸

cargo(1), cargo-doc(1), rustdoc(1)

And that's the whole page, bestie — this was the CARGO-RUSTDOC(1) manual, straight from the Cargo crew, no date stamp needed because it's timeless fr fr. Go build something iconic. 💅✨🦋

📦 where this page comes from