Provided by: cargo_0.62.0ubuntu1-0ubuntu2_amd64 bug


       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.


   Documentation Options
           Open the docs in a browser after building them. This will use your default browser
           unless you define another one in the BROWSER environment variable or use the
           doc.browser <>
           configuration option.

           Do not build documentation for dependencies.

           Include non-public items in the documentation. This will be enabled by default if
           documenting a binary target.

   Package Selection
       By default, when no package selection options are given, the packages selected depend on
       the selected manifest file (based on the current working directory if --manifest-path is
       not given). If the manifest is the root of a workspace then the workspaces default members
       are selected, otherwise only the package defined by the manifest will be selected.

       The default members of a workspace can be set explicitly with the
       workspace.default-members key in the root manifest. If this is not set, a virtual
       workspace will include all workspace members (equivalent to passing --workspace), and a
       non-virtual workspace will include only the root crate itself.

       -p spec..., --package spec...
           Document only the specified packages. See cargo-pkgid(1) for the SPEC format. This
           flag may be specified multiple times and supports 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 pattern.

           Document all members in the workspace.

           Deprecated alias for --workspace.

       --exclude SPEC...
           Exclude the specified packages. Must be used in conjunction with the --workspace flag.
           This flag may be specified multiple times and supports 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 pattern.

   Target Selection
       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 doc 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 and supports
           common Unix glob patterns.

           Document all binary targets.

       --example name...
           Document the specified example. This flag may be specified multiple times and supports
           common Unix glob patterns.

           Document all example targets.

   Feature Selection
       The feature flags allow you to control which features are enabled. When no feature options
       are given, the default feature is activated for every selected package.

       See the features documentation
       <> for
       more details.

       --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.

           Activate all available features of all selected packages.

           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 may also be specified with the config value

           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 for more

       -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 the reference
           <> for more details on

           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.

           Output information 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

           •  html: 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 config value
           <>. 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

       -q, --quiet
           Do not print cargo log messages. May also be specified with the term.quiet config
           value <>.

       --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

       --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

           •  short: Emit shorter, human-readable text messages. Conflicts with human and json.

           •  json: Emit JSON messages to stdout. See the reference
               <> 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 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.

           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

           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 net.offline config value

   Common Options
           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 <> for
           more information about how toolchain overrides work.

       -h, --help
           Prints help information.

       -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 config value
           <>. Defaults to the number of

           Build as many crates in the dependency graph as possible, rather than aborting the
           build on the first one that fails to build. Unstable, requires -Zunstable-options.


       See the reference <>
       for details on environment variables that Cargo reads.


0: Cargo succeeded.

       •  101: Cargo failed to complete.


        1. Build the local package documentation and its dependencies and output to target/doc.

               cargo doc


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