From f6148d7cbad6423846d513e56d1666d8482f7105 Mon Sep 17 00:00:00 2001 From: Omnath Mandal <145841395+htanmo@users.noreply.github.com> Date: Sun, 8 Oct 2023 15:50:48 +0530 Subject: [PATCH] cargo-rustdoc: add page (#10828) * cargo-rustdoc: add page --------- Co-authored-by: pixel Co-authored-by: K.B.Dharun Krishna --- pages/common/cargo-rustdoc.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 pages/common/cargo-rustdoc.md diff --git a/pages/common/cargo-rustdoc.md b/pages/common/cargo-rustdoc.md new file mode 100644 index 000000000..214e755eb --- /dev/null +++ b/pages/common/cargo-rustdoc.md @@ -0,0 +1,32 @@ +# cargo rustdoc + +> Generate documentation for the Rust package. +> More information: . + +- 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`