sphinxcontrib_rust.index

Module for code related to generating the index of Rust items

Classes

RustIndex(domain)

Class for implementing the index of Rust items.

class sphinxcontrib_rust.index.RustIndex(domain: Domain)

Class for implementing the index of Rust items.

The class inherits from Index and produces an index of the various items documented in the build. The index sections are the item types.

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.