cargo-doc (1) Linux Manual Page
cargo-doc – Build a package’s documentation
Synopsis
cargo doc [OPTIONS]Description
Build a package’s documentation.By default the documentation for the local package and all dependencies is built. The output is all placed in ‘target/doc’ in rustdoc’s usual format.
If the –package argument is given, then SPEC is a package id specification which indicates which package should be built. If it is not given, then the current package is built. For more information on SPEC and its format, see the "cargo help pkgid" command.
Options
- -h, –help
- Print this message.
- -p SPEC, –package SPEC …
- Package to document.
- –open
- Opens the docs in a browser after the operation.
- –no-deps
- Don’t build documentation for dependencies.
- -j N, –jobs N
- Number of parallel jobs, defaults to # of CPUs.
- –release
- Build artifacts in release mode, with optimizations.
- –features FEATURES
- Space-separated list of features to also build.
- –all-features
- Build all available features.
- –no-default-features
- Do not build the default feature.
- –target TRIPLE
- Build for the target triple.
- –manifest-path PATH
- Path to the manifest to compile.
- -v, –verbose
- Use verbose output.
- -q, –quiet
- No output printed to stdout.
- –color WHEN
- Coloring: auto, always, never.
Examples
Build a local package documentation in ‘target/doc’$
cargo doc