2025-03-14 21:59:59 -06:00
|
|
|
# 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:
|
|
|
|
|
|
2025-03-19 19:23:44 -06:00
|
|
|
`cargo {{[d|doc]}}`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Do not build documentation for dependencies:
|
|
|
|
|
|
2025-03-19 19:23:44 -06:00
|
|
|
`cargo {{[d|doc]}} --no-deps`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Build and open the documentation in a browser:
|
|
|
|
|
|
2025-03-19 19:23:44 -06:00
|
|
|
`cargo {{[d|doc]}} --open`
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Build and view the documentation of a particular package:
|
|
|
|
|
|
2025-03-19 19:23:44 -06:00
|
|
|
`cargo {{[d|doc]}} --open {{[-p|--package]}} {{package}}`
|
