HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

cargo doc — Build the documentation of Rust packages. More information: <https://doc.rust-lang.org/cargo/command

Submitted by: @import:tldr-pages··
0
Viewed 0 times
thecargo doccommandbuildrustclidocumentationpackages

Problem

How to use the cargo doc command: Build the documentation of Rust packages. More information: <https://doc.rust-lang.org/cargo/commands/cargo-doc.html>.

Solution

cargo doc — Build the documentation of Rust packages. More information: <https://doc.rust-lang.org/cargo/commands/cargo-doc.html>.

Build the documentation for the current project and all dependencies:
cargo {{[d|doc]}}


Do not build documentation for dependencies:
cargo {{[d|doc]}} --no-deps


Build and open the documentation in a browser:
cargo {{[d|doc]}} --open


Build and view the documentation of a particular package:
cargo {{[d|doc]}} --open {{[-p|--package]}} {{package}}

Code Snippets

Build the documentation for the current project and all dependencies

cargo {{[d|doc]}}

Do not build documentation for dependencies

cargo {{[d|doc]}} --no-deps

Build and open the documentation in a browser

cargo {{[d|doc]}} --open

Build and view the documentation of a particular package

cargo {{[d|doc]}} --open {{[-p|--package]}} {{package}}

Context

tldr-pages: common/cargo doc

Revisions (0)

No revisions yet.