From f6dcb78026d750ad14492598ffa32be97dd0f876 Mon Sep 17 00:00:00 2001 From: Fyodor Dostoevsky <124738924+DostoevskyOnLinux@users.noreply.github.com> Date: Mon, 9 Oct 2023 13:08:14 -0500 Subject: [PATCH] rustdoc: add page (#10902) * rustdoc: add page --------- Co-authored-by: K.B.Dharun Krishna --- pages/common/rustdoc.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 pages/common/rustdoc.md diff --git a/pages/common/rustdoc.md b/pages/common/rustdoc.md new file mode 100644 index 000000000..0cc30ef90 --- /dev/null +++ b/pages/common/rustdoc.md @@ -0,0 +1,20 @@ +# rustdoc + +> Generate documentation for a Rust crate. +> More information: . + +- Generate documentation from the crate's root: + +`rustdoc {{src/lib.rs}}` + +- Pass a name for the project: + +`rustdoc {{src/lib.rs}} --crate-name {{name}}` + +- Generate documentation from Markdown files: + +`rustdoc {{path/to/file.md}}` + +- Specify the output directory: + +`rustdoc {{src/lib.rs}} --out-dir {{path/to/output_directory}}`