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`