sphinx.environment.adapters.indexentries.IndexEntries

class documentation

class IndexEntries: (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method create_index Create the real index from the collected index entries.
Instance Variable env Undocumented
def __init__(self, env): (source)

Undocumented

Parameters
env:BuildEnvironmentUndocumented
def create_index(self, builder, group_entries=True, _fixre=re.compile(r'(.*) (\([^\(\)]*\))')): (source)

Create the real index from the collected index entries.

Parameters
builder:BuilderUndocumented
group_entries:boolUndocumented
_fixre:re.PatternUndocumented
Returns
list[tuple[str, list[tuple[str, Any]]]]Undocumented
env = (source)

Undocumented