Sphinx Rust

Auto-document Rust code with Sphinx!

Warning

This project is in early development and is not yet ready for production use.

This package is intended to bring API documentation for rust crates to Sphinx:

  • Auto-analysis of Rust crates

  • Auto-documentation of Rust crates: the documentation is generated to closely mirror the format of https://docs.rs

  • Integrates with sphinx cross-referencing system and inter-sphinx indexing

  • Supports writing docstrings for any valid Sphinx parser (reStructuredText, MyST markdown, etc.)

Installation

pip install sphinx-rust

Usage

Add sphinx_rust to your conf.py, and specifiy the paths to the Rust crates you want to document:

extensions = [
    "sphinx_rust",
]
rust_crates = [
    "../path/to/crate",
    ...
]
...

That’s it!

Now you can use the rust cross-referencing roles to link to items in your Rust crates:

- :rust:module:`analyzer::analyze`
- :rust:struct:`analyze::struct_::Struct`
- :rust:enum:`analyze::type_::TypeSegment`

API Examples