- Home
- Documentation Generators
- rustdoc
On the recordRead 5 Oct 202624 facts
rustdoc
On the record
- Cargo integration
- Cargo integrates with rustdoc through `cargo doc` and can open generated documentation with `cargo doc --open`.doc.rust-lang.org · read 5 Oct 2026
- Cross compilation
- The `--target` option generates documentation for a target triple different from the host triple, subject to the usual cross-compilation caveats.doc.rust-lang.org · read 5 Oct 2026
- Default visibility
- By default, rustdoc generates documentation for public functions.doc.rust-lang.org · read 4 Oct 2026
- Distribution
- The standard Rust distribution includes rustdoc.doc.rust-lang.org · read 5 Oct 2026
- Documentation tests
- rustdoc can execute code examples in documentation as tests to check that they compile and run.doc.rust-lang.org · read 5 Oct 2026
- Included tool
- The standard Rust distribution ships with rustdoc.doc.rust-lang.org · read 4 Oct 2026
- Installation
- Rust's installation page recommends rustup and provides installation instructions for Windows, macOS, Linux, and other Unix-like systems.rust-lang.org · read 4 Oct 2026
- Install platforms
- The Rust installation page provides installation instructions for Windows, macOS, and Linux or other Unix-like systems.rust-lang.org · read 5 Oct 2026
- Integration output
- Cargo places generated documentation under the project's `target` directory and can include documentation for dependencies.doc.rust-lang.org · read 4 Oct 2026
- Licensing
- The Rust Programming Language and official Rust projects are generally dual-licensed under Apache License 2.0 and the MIT license; the page directs readers to each project's GitHub repository for specific licensing information.rust-lang.org · read 4 Oct 2026
- Maker identity
- The Rust website says it is maintained by the Rust Team.rust-lang.org · read 5 Oct 2026
- Markdown input
- rustdoc can generate HTML from standalone Markdown files; Cargo currently does not understand standalone Markdown files.doc.rust-lang.org · read 5 Oct 2026
- Markdown limitation
- Cargo does not currently understand standalone Markdown files.doc.rust-lang.org · read 4 Oct 2026
- Online documentation
- The Rust tools page says Cargo's doc builder is available locally through `cargo doc` and online for public crates through docs.rs.rust-lang.org · read 4 Oct 2026
- Output customization
- Command-line options can select an output directory, add themes, and include extra CSS or HTML in generated documentation.doc.rust-lang.org · read 5 Oct 2026
- Project governance
- The Rust Project says it is composed of many teams and contributors, and that major decisions start with a Request for Comments process open to everyone.rust-lang.org · read 4 Oct 2026
- Purpose
- rustdoc generates documentation for Rust projects from a crate root or Markdown file, producing HTML, CSS, and JavaScript.doc.rust-lang.org · read 5 Oct 2026
- Security reporting
- The Rust Project asks that security bugs in the Rust distribution be reported to [email protected] and says reports are acknowledged within 24 hours, with a more detailed response within 48 hours.rust-lang.org · read 4 Oct 2026
