Augmented docs: a love letter to rustdoc and docs.rs
summary
Shows concrete hacks and outcomes: rustdoc runs examples as doctests and supports include_str and attribute-driven docs, docs.rs archives every published version and uses nightly for extra features, and rustdoc emits rustdoc JSON usable to generate derived docs or APIs. Demonstrates crates and extensions that actually render in docs — aquamarine graphs, katex-doc math, document-features feature tables — and practical cfg(doc)/Cargo.toml settings, mdbook and zola pipelines, plus Diátaxis and Good Docs Project guidance.
AI-written summary · about
chapters (14)
- 0:00Rust documentation intro
- 1:04Why documenting code matters
- 3:34Rust docs tools
- 5:19Advanced rustdoc features
- 8:09Customizing docs with attributes
- 11:04Conditional compilation in docs
- 13:35Enhancing docs with HTML/CSS
- 15:27Extending docs with crates
- 16:33Contributing to rustdoc/docs.rs
- 17:37Advanced docs search
- 19:27Docs frameworks & guidelines
- 21:13Organizing docs with datataxonomy
- 23:23Book builders & SSG
- 24:05Conclusion and key takeaways
related talks
32mDocumentation in the Rust Ecosystem
31mThe Dark Secrets Lurking Inside cargo doc
24mEscaping the Curse of Outdated Docs
18mThe Death and Rebirth of Docs.rs
24mReasoning about Rust: an introduction to Rustdoc's JSON format
51mWriting the Darn Docs
35mOpenAPI for Documentarians
44mPushing documentation (so it doesn't hurt anymore)