1. 1. What is rustdoc?
  2. 2. Command-line arguments
  3. 3. How to read rustdoc output
  4. 4. How to write documentation
    1. 4.1. What to include (and exclude)
    2. 4.2. The #[doc] attribute
    3. 4.3. Linking to items by name
    4. 4.4. Documentation tests
  5. 5. Rustdoc-specific lints
  6. 6. Scraped examples
  7. 7. Advanced features
  8. 8. Unstable features
  9. 9. Deprecated features
  10. 10. References

The rustdoc book

References

There are many great rustdoc references out there. If you know of other great resources, please submit a pull request!

Official

  • Learn Rust
  • Rust By Example
  • Rust Reference
  • RFC 1574: More API Documentation Conventions
  • RFC 1946: Intra Rustdoc Links

Community

  • API Guidelines
  • Github tagged RFCs
  • Github tagged issues
  • RFC (stalled) front page styleguide
  • Guide on how to write documentation for a Rust crate