Index
Table of Contents
Classes
- GenIndexNode
- The genindex content for a page: a term tree collected and populated by
IndexCollectorPass, either project-wide (the `:template: genindex` page)
or -- when created by GenIndexDirective -- restricted to documents whose
path starts with one of $pathPrefixes.
- GenIndexRow
- One rendered row of a genindex term: either a direct link to a section
("link"), or a "see"/"seealso" cross-reference to another term.
- GenIndexTerm
- All entries collected for a single genindex term, e.g. "configuration".
- IndexEntryNode
- One parsed line of a `.. index::` directive, e.g. `single: foo` or `pair: a; b`.
- IndexNode
- Wraps the entries collected from one `.. index::` directive occurrence.
Enums
- GenIndexRowKind
- Whether a genindex row is a direct link to a section, or a "see"/"seealso" cross-reference to another term.
- IndexEntryType
- The kind of entry declared in a `.. index::` directive line, e.g. `single: foo` or `pair: a; b`.