2019-12-28 08:18:12 -05:00
|
|
|
# cargo doc
|
|
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
> Build the documentation of Rust packages.
|
2019-12-28 08:18:12 -05:00
|
|
|
> More information: <https://doc.rust-lang.org/cargo/commands/cargo-doc.html>.
|
|
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
- Build the documentation for the current project and all dependencies:
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
`cargo doc`
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
- Do not build documentation for dependencies:
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
`cargo doc --no-deps`
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
- Build and open the documentation in a browser:
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
`cargo doc --open`
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
- Build and view the documentation of a particular package:
|
2019-12-28 08:18:12 -05:00
|
|
|
|
2023-10-29 09:54:53 +01:00
|
|
|
`cargo doc --open --package {{package}}`
|
