mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-04-29 23:24:55 +02:00
cargo-rustdoc: add page (#10828)
* cargo-rustdoc: add page --------- Co-authored-by: pixel <pixel+github@chrissx.de> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
parent
6b2ee7e0e5
commit
f6148d7cba
1 changed files with 32 additions and 0 deletions
32
pages/common/cargo-rustdoc.md
Normal file
32
pages/common/cargo-rustdoc.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
# 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`
|
Loading…
Add table
Reference in a new issue