mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-04-29 23:24:55 +02:00
f6148d7cba
* cargo-rustdoc: add page --------- Co-authored-by: pixel <pixel+github@chrissx.de> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
32 lines
598 B
Markdown
32 lines
598 B
Markdown
# cargo rustdoc
|
|
|
|
> Generate documentation for the Rust package.
|
|
> More information: <https://doc.rust-lang.org/cargo/commands/cargo-rustdoc.html>.
|
|
|
|
- Open the documentation in the browser:
|
|
|
|
`cargo rustdoc --open`
|
|
|
|
- Specify the package to document:
|
|
|
|
`cargo rustdoc --package {{spec}}`
|
|
|
|
- Document the package's library:
|
|
|
|
`cargo rustdoc --lib`
|
|
|
|
- Document the specified binary:
|
|
|
|
`cargo rustdoc --bin {{name}}`
|
|
|
|
- Document the specified example:
|
|
|
|
`cargo rustdoc --example {{name}}`
|
|
|
|
- Document the specified integration test:
|
|
|
|
`cargo rustdoc --test {{name}}`
|
|
|
|
- Display help:
|
|
|
|
`cargo rustdoc --help`
|