1. 1. What is rustdoc?
  2. 2. How to write documentation
  3. 3. What to include (and exclude)
  4. 4. Command-line arguments
  5. 5. The #[doc] attribute
  6. 6. Documentation tests
  7. 7. Linking to items by name
  8. 8. Lints
  9. 9. Advanced features
  10. 10. Unstable features
  11. 11. Website features
  12. 12. Passes
  13. 13. 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 documenation for a Rust crate