cargo-doc (1) - Linux Manuals

cargo-doc: Build a package's documentation

NAME

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

COPYRIGHT

This work is dual-licensed under Apache 2.0 and MIT terms. See COPYRIGHT file in the cargo source distribution.