Struct SphinxIndexBuilder 

pub struct SphinxIndexBuilder { /* private fields */ }

Sphinx’s IndexBuilder: fed one resolved document at a time by the build’s resolve phase (Sphinx: write_doc_serialized → index_page → feed), then frozen once into the searchindex.js value.

Feeding the resolved doctree is what makes cross-reference text match: a :doc: or :ref: without an explicit title indexes the target’s title, which is the text of the reference ReferencesResolver built.

Implementations

impl SphinxIndexBuilder

pub fn new() -> Self

pub fn feed( &mut self, docname: &str, filename: &str, title: &str, doctree: &Doctree, env: &BuildEnvironment, )

IndexBuilder.feed, behind the index_page gate: a document whose metadata carries :nosearch: (or :no-search:) is fed an empty title and an empty document, so it keeps its slot in docnames and contributes nothing else.

pub fn freeze(&self, env: &BuildEnvironment) -> Value

IndexBuilder.freeze: the Search.setIndex payload.

Trait Implementations

impl Debug for SphinxIndexBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SphinxIndexBuilder

fn default() -> SphinxIndexBuilder

Returns the “default value” for a type.