RUSTDOC(1)

📦 version 1.97.1, in ubuntu stonking

💅 rustdoc (1) — User Commands 💅

okay bestie, welcome to the rustdoc page 🌈 this is the tool that takes your Rust source code and turns your comments into ✨glorious API reference documentation✨

✨ NAME ✨

rustdoc — generate documentation from Rust source code 🦋

✨ SYNOPSIS ✨

rustdoc [OPTIONS] INPUT

✨ DESCRIPTION ✨

so the way that this works 💖 rustdoc generates API reference documentation by extracting comments from source code written in the Rust language, which lives at <https://www.rust-lang.org> in case you need it. it accepts several input formats and provides several output formats for the generated documentation. it's giving "your comments but make them a website" and we're obsessed 😌✨

✨ OPTIONS ✨

  • -r, --input-format FORMAT — the input format, and bestie the value is rust 🦀
  • -w, --output-format FORMAT — the output format, and the value here is html 🌸
  • -o, --output OUTPUT, — where to place the output (default: doc/ for html). also yes there is a little stray comma in there, we love her, she stays 💀
  • --passes LIST — space-separated list of passes to run (default: '') 🔥
  • --no-defaults — don't run the default passes 🙈
  • --plugins LIST — space-separated list of plugins to run (default: '') 🧚
  • --plugin-path DIR — directory to load plugins from (default: /tmp/rustdoc_ng/plugins) 📁
  • --target TRIPLE — target triple to document 👑
  • --crate-name NAME — specify the name of this crate 🎀
  • -L, --library-path DIR — directory to add to crate search path 🔍
  • --cfg SPEC — pass a --cfg to rustc 💜
  • --extern VAL — pass an --extern to rustc 💜
  • --test — run code examples as tests 🧪 lowkey iconic of her
  • --test-args ARGS — pass arguments to the test runner 🏃‍♀️
  • --html-in-header FILE — file to add to <head> 🌐
  • --html-before-content FILES — files to include inline between <body> and the content of a rendered Markdown file or generated documentation 🌈
  • --markdown-before-content FILES — files to include inline between <body> and the content of a rendered Markdown file or generated documentation 🌈
  • --html-after-content FILES — files to include inline between the content and </body> of a rendered Markdown file or generated documentation 🌈
  • --markdown-after-content FILES — files to include inline between the content and </body> of a rendered Markdown file or generated documentation 🌈
  • --markdown-css FILES — CSS files to include via <link> in a rendered Markdown file Markdown file or generated documentation 🎨 (yeah she said "Markdown file" twice, no cap, we're keeping it exactly as she is 💅)
  • --markdown-playground-url URL — URL to send code snippets to 🏖️
  • --markdown-no-toc — don't include table of contents 🚫📑
  • -h, --extend-css — to redefine some css rules with a given file to generate doc with your own theme 🎨 (yes, -h is the short flag for this one here, not help — stay woke bestie 👀)
  • -V, --version — Print rustdoc's version 📢

✨ OUTPUT FORMATS ✨

the rustdoc tool can generate output in an HTML format 🦋

if using an HTML format, then the specified output destination will be the root directory of an HTML structure for all the documentation. pages will be placed into this directory, and source files will also possibly be rendered into it as well. so like, everything's going in there, it's the whole vibe 🏠✨

✨ EXAMPLES ✨

to generate documentation for the source in the current directory:

$ rustdoc hello.rs

list all available passes that rustdoc has, along with default passes:

$ rustdoc --passes list

the generated HTML can be viewed with any standard web browser 🌐 main character browsing experience fr fr

✨ SEE ALSO ✨

rustc(1) — go say hi to her sibling 💖

✨ BUGS ✨

found a bug? see <https://github.com/rust-lang/rust/issues> for issues 🐛 no pressure but like, tell them

✨ AUTHOR ✨

see the version control history or <https://thanks.rust-lang.org> 🫶 shoutout to everyone in the git log

this work is dual-licensed under Apache 2.0 and MIT terms 📜 see COPYRIGHT file in the rust source distribution.

okay that's the whole page bestie, you ate that 💅✨

signing off with the vibe check: this was rustdoc 1.97.1 (8bab26f4f 2026-... from July 2018 🌸 (yes the date is a whole situation, don't @ her), and we're out here being RUSTDOC(1) — periodt 👑💖

📦 where this page comes from