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>
pull/23/head
Omnath Mandal 2023-10-08 15:50:48 +05:30 committed by GitHub
parent 6b2ee7e0e5
commit f6148d7cba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 0 deletions

View 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`