From c8931b963edfeb64bb5bd58182d6e3c3d861aec8 Mon Sep 17 00:00:00 2001 From: Jonathan Dahan Date: Sat, 28 Dec 2019 08:18:12 -0500 Subject: [PATCH] cargo-doc: add page (#3697) Co-authored-by: Agniva De Sarker --- pages/common/cargo-doc.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 pages/common/cargo-doc.md diff --git a/pages/common/cargo-doc.md b/pages/common/cargo-doc.md new file mode 100644 index 0000000000..99e2443527 --- /dev/null +++ b/pages/common/cargo-doc.md @@ -0,0 +1,20 @@ +# cargo doc + +> Build and view Rust package documentation offline. +> More information: . + +- Build and view the default package documentation in the browser: + +`cargo doc --open` + +- Build documentation without accessing the network: + +`cargo doc --offline` + +- View a particular package's documentation: + +`cargo doc --open --package {{package}}` + +- View a particular package's documentation offline: + +`cargo doc --open --offline --package {{package}}`