Browse Source

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>
Omnath Mandal 1 year ago
parent
commit
f6148d7cba
1 changed files with 32 additions and 0 deletions
  1. 32 0
      pages/common/cargo-rustdoc.md

+ 32 - 0
pages/common/cargo-rustdoc.md

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