Rust specific indices

The extension produces an index for each item type, except impl blocks. The generated indices are saved as rust-<item>s.html in the build directory. They can be referenced using the Sphinx’s built-in referencing. To reference the struct index, use :ref:`rust-structs` as the inline reference. This will create a link to the index of structs.

The indices are mainly useful for display in the sidebar and have to be incorporated in the CSS theme used for the Sphinx build.

Available indices:

  • rust-crates

  • rust-enums

  • rust-functions

  • rust-modules

  • rust-structs

  • rust-traits

  • rust-variables

Rust Crates

Rust Structs