MAN page from OpenSuSE cargo-1.32.0-189.8.x86_64.rpm

CARGO\-DOC

Section: Cargo Manual (1)
Updated: May 2016
Index

NAME

cargo-doc - Build a package[aq]s documentation

SYNOPSIS

I]cargo doc] [OPTIONS]

DESCRIPTION

Build a package[aq]s documentation.

By default the documentation for the local package and all dependenciesis built.The output is all placed in [aq]target/doc[aq] in rustdoc[aq]s usualformat.

If the B]--package] argument is given, then I]SPEC] is apackage id specification which indicates which package should be built.If it is not given, then the current package is built.For more information on I]SPEC] and its format, see the "cargohelp pkgid" command.

OPTIONS

-h, --help

Print this message.

-p I]SPEC], --package I]SPEC ...]

Package to document.

--open

Opens the docs in a browser after the operation.

--no-deps

Don[aq]t build documentation for dependencies.

-j I]N], --jobs I]N]

Number of parallel jobs, defaults to # of CPUs.

--release

Build artifacts in release mode, with optimizations.

--features I]FEATURES]

Space-separated list of features to also build.

--all-features

Build all available features.

--no-default-features

Do not build the C]default] feature.

--target I]TRIPLE]

Build for the target triple.

--manifest-path I]PATH]

Path to the Cargo.toml to compile.

-v, --verbose

Use verbose output.

-q, --quiet

No output printed to stdout.

--color I]WHEN]

Coloring: auto, always, never.

EXAMPLES

Build a local package documentation in [aq]target/doc[aq]

C]$ cargo doc]

COPYRIGHT

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

This document was created byman2html,using the manual pages.