rustdoc

Spec sheet

Purpose

rustdoc generates documentation for Rust projects from a crate root or Markdown file, producing HTML, CSS, and JavaScript.Read 5 Oct 2026 · doc.rust-lang.org

Support

The Rust site directs users to the documentation, Rust Forge contributor documentation, and the Users Forum for help.Read 5 Oct 2026 · rust-lang.org

Cargo integration

Cargo integrates with rustdoc through `cargo doc` and can open generated documentation with `cargo doc --open`.Read 5 Oct 2026 · doc.rust-lang.org

Cross compilation

The `--target` option generates documentation for a target triple different from the host triple, subject to the usual cross-compilation caveats.Read 5 Oct 2026 · doc.rust-lang.org

Default visibility

By default, rustdoc generates documentation for public functions.Read 4 Oct 2026 · doc.rust-lang.org

Distribution

The standard Rust distribution includes rustdoc.Read 5 Oct 2026 · doc.rust-lang.org

Documentation tests

rustdoc can execute code examples in documentation as tests to check that they compile and run.Read 5 Oct 2026 · doc.rust-lang.org

Included tool

The standard Rust distribution ships with rustdoc.Read 4 Oct 2026 · doc.rust-lang.org

Install platforms

The Rust installation page provides installation instructions for Windows, macOS, and Linux or other Unix-like systems.Read 5 Oct 2026 · rust-lang.org

Installation

Rust's installation page recommends rustup and provides installation instructions for Windows, macOS, Linux, and other Unix-like systems.Read 4 Oct 2026 · rust-lang.org

Integration output

Cargo places generated documentation under the project's `target` directory and can include documentation for dependencies.Read 4 Oct 2026 · doc.rust-lang.org

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.Read 4 Oct 2026 · rust-lang.org

Maker identity

The Rust website says it is maintained by the Rust Team.Read 5 Oct 2026 · rust-lang.org

Markdown input

rustdoc can generate HTML from standalone Markdown files; Cargo currently does not understand standalone Markdown files.Read 5 Oct 2026 · doc.rust-lang.org

Markdown limitation

Cargo does not currently understand standalone Markdown files.Read 4 Oct 2026 · doc.rust-lang.org

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.Read 4 Oct 2026 · rust-lang.org

Output customization

Command-line options can select an output directory, add themes, and include extra CSS or HTML in generated documentation.Read 5 Oct 2026 · doc.rust-lang.org

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.Read 4 Oct 2026 · rust-lang.org

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.Read 4 Oct 2026 · rust-lang.org

Security support scope

The Rust Security Response Working Group handles vulnerability reports for software maintained and published by the Rust Project; third-party crates are outside its stated scope.Read 4 Oct 2026 · rust-lang.org

Supported updates

The Rust Project says it provides support and security updates for the most recent stable release and the latest beta and nightly releases.Read 4 Oct 2026 · rust-lang.org

Test controls

Documentation code blocks support attributes including `ignore`, `should_panic`, `no_run`, and `compile_fail`.Read 5 Oct 2026 · doc.rust-lang.org

Visibility default

By default, rustdoc documents publicly reachable items; `--document-private-items` includes non-public items except those marked `#[doc(hidden)]`.Read 5 Oct 2026 · doc.rust-lang.org

Windows requirement

On Windows, Rust additionally requires the MSVC build tools for Visual Studio 2013 or later.Read 5 Oct 2026 · rust-lang.org

Where Specifiction places it

• Documentation Generators#23 of 377.4