sphinxcontrib_rust.index

The module defines the RustIndex class which is the base class for the indices generated for Rust objects. The class is inherited by the specific index classes for each Rust object type.

Classes

`CrateIndex`(domain)	Index of the Rust crates in the project
`EnumIndex`(domain)	Index of the Rust enums in the project
`FunctionIndex`(domain)	Index of the Rust functions in the project
`ModuleIndex`(domain)	Index of the Rust modules in the project
`RustIndex`(domain)	Abstract class to implement the various Sphinx indices
`StructIndex`(domain)	Index of the Rust structs in the project
`TraitIndex`(domain)	Index of the Rust traits in the project
`TypeIndex`(domain)	Index of the Rust types in the project
`VariableIndex`(domain)	Index of the Rust variables in the project

class sphinxcontrib_rust.index.CrateIndex(domain: Domain)

Index of the Rust crates in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.EnumIndex(domain: Domain)

Index of the Rust enums in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.FunctionIndex(domain: Domain)

Index of the Rust functions in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.ModuleIndex(domain: Domain)

Index of the Rust modules in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.RustIndex(domain: Domain)

Abstract class to implement the various Sphinx indices

generate(docnames: Iterable[str] | None = None) → tuple[list[tuple[str, list[IndexEntry]]], bool]

Generate the index content for a list of items of the same type

Args:

items:: The items to include in the index.
subtype:: The sub-entry related type. One of 0 - A normal entry 1 - A entry with subtypes. 2 - A sub-entry

Returns:

A list of (key, list[IndexEntry]) tuples that can be used as the content for generating the index.

abstract property rust_obj_type: RustItemType: The Rust object type for the index

class sphinxcontrib_rust.index.StructIndex(domain: Domain)

Index of the Rust structs in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.TraitIndex(domain: Domain)

Index of the Rust traits in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.TypeIndex(domain: Domain)

Index of the Rust types in the project

property rust_obj_type: The Rust object type for the index

class sphinxcontrib_rust.index.VariableIndex(domain: Domain)

Index of the Rust variables in the project

property rust_obj_type: The Rust object type for the index