sphinx.domains.python.PythonModuleIndex

class documentation

class PythonModuleIndex(Index):

View In Hierarchy

Index subclass to provide the Python module index.
Method generate Get entries for the index.
Class Variable localname Undocumented
Class Variable name Undocumented
Class Variable shortname Undocumented

Inherited from Index:

Method __init__ Undocumented
Instance Variable domain Undocumented
def generate(self, docnames=None):
overrides sphinx.domains.Index.generate

Get entries for the index.

If docnames is given, restrict to entries referring to these docnames.

The return value is a tuple of (content, collapse):

collapse
A boolean that determines if sub-entries should start collapsed (for output formats that support collapsing sub-entries).
content:

A sequence of (letter, entries) tuples, where letter is the "heading" for the given entries, usually the starting letter, and entries is a sequence of single entries. Each entry is a sequence [name, subtype, docname, anchor, extra, qualifier, descr]. The items in this sequence have the following meaning:

name
The name of the index entry to be displayed.
subtype

The sub-entry related type. One of:

0
A normal entry.
1
An entry with sub-entries.
2
A sub-entry.
docname
docname where the entry is located.
anchor
Anchor for the entry within docname
extra
Extra info for the entry.
qualifier
Qualifier for the description.
descr
Description for the entry.

Qualifier and description are not rendered for some output formats such as LaTeX.

Parameters
docnames:Iterable[str]Undocumented
Returns
Tuple[List[Tuple[str, List[IndexEntry]]], bool]Undocumented
localname =
overrides sphinx.domains.Index.localname

Undocumented

name: str =
overrides sphinx.domains.Index.name

Undocumented

shortname =
overrides sphinx.domains.Index.shortname

Undocumented