rustdoc

Free plan LinuxMacWindows

What rustdoc is

rustdoc is the documentation generator included with the standard Rust distribution. It turns Rust crate roots or standalone Markdown files into HTML, CSS, and JavaScript. Cargo connects to rustdoc through `cargo doc`, placing generated project documentation in the `target` directory and optionally documenting dependencies. By default, it documents publicly reachable items; `--document-private-items` can include non-public items except those marked `#[doc(hidden)]`. Documentation examples can run as tests, with controls for ignored, panicking, non-running, or expected-to-fail code blocks. Command-line options can set an output directory, add themes, include CSS or HTML, and generate documentation for another target triple, subject to cross-compilation caveats. Cargo does not currently handle standalone Markdown files. Rust installation guidance recommends rustup for Windows, macOS, Linux, and other Unix-like systems. rustdoc is free on Linux, macOS, and Windows, and public crates can publish online documentation through docs.rs.

Who it suits

rustdoc suits Rust developers who need generated API references, project documentation, or tested code examples. It is useful with Cargo projects and standalone Markdown workflows where the documented limitations are acceptable.

What it does well

Included with the standard Rust distribution
Generates HTML, CSS, and JavaScript
Runs documentation examples as tests
Supports private-item documentation options
Available on Linux, macOS, and Windows

What to know first

Cargo does not handle standalone Markdown files
Cross-target output has usual cross-compilation caveats
Windows requires MSVC build tools

Verdict

rustdoc provides a free, Rust-focused path from source or Markdown to browsable documentation, with Cargo integration and testable examples. Its standalone-Markdown limitation and Windows build-tool requirement matter when planning installation or workflows.

Facts from rustdoc's own pages

Cargo integration: Cargo integrates with rustdoc through `cargo doc` and can open generated documentation with `cargo doc --open`. · doc.rust-lang.org, 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, 5 Oct 2026
Default visibility: By default, rustdoc generates documentation for public functions. · doc.rust-lang.org, 4 Oct 2026
Distribution: The standard Rust distribution includes rustdoc. · doc.rust-lang.org, 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, 5 Oct 2026
Included tool: The standard Rust distribution ships with rustdoc. · doc.rust-lang.org, 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, 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, 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, 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, 4 Oct 2026
Maker identity: The Rust website says it is maintained by the Rust Team. · rust-lang.org, 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, 5 Oct 2026
Markdown limitation: Cargo does not currently understand standalone Markdown files. · doc.rust-lang.org, 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, 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, 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, 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, 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, 4 Oct 2026
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. · rust-lang.org, 4 Oct 2026
Support: The Rust site directs users to the documentation, Rust Forge contributor documentation, and the Users Forum for help. · rust-lang.org, 5 Oct 2026
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. · rust-lang.org, 4 Oct 2026
Test controls: Documentation code blocks support attributes including `ignore`, `should_panic`, `no_run`, and `compile_fail`. · doc.rust-lang.org, 5 Oct 2026
Visibility default: By default, rustdoc documents publicly reachable items; `--document-private-items` includes non-public items except those marked `#[doc(hidden)]`. · doc.rust-lang.org, 5 Oct 2026
Windows requirement: On Windows, Rust additionally requires the MSVC build tools for Visual Studio 2013 or later. · rust-lang.org, 5 Oct 2026

Where rustdoc stands on Freedom251

Documentation Generators#25 of 37