1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-22 01:22:09 +02:00
tldr/pages/common/rustdoc.md
Fyodor Dostoevsky f6dcb78026
rustdoc: add page (#10902)
* rustdoc: add page

---------

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
2023-10-09 23:38:14 +05:30

449 B

rustdoc

Generate documentation for a Rust crate. More information: https://doc.rust-lang.org/stable/rustdoc.

  • 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}}