IndexCollector
Table of Contents
Classes
- GenIndexNodeBuilder
- Turns a (already see-resolved) term map into a sorted `GenIndexTerm` node
tree.
- GenIndexRowData
- One collected genindex row, before it's turned into a rendered
{@see \phpDocumentor\Guides\Nodes\Index\GenIndexRow} node: either a direct
link to a section, or a "see"/"seealso" cross-reference to another term.
- GenIndexSeeResolver
- Points every `see`/`seealso` row at the anchor of the term it targets.
- GenIndexTermData
- All rows collected for a single genindex term or subterm, before it's
turned into a rendered {@see \phpDocumentor\Guides\Nodes\Index\GenIndexTerm}
node. Only ever nested one level deep in practice (a subterm's own
`subterms` stays empty), the same convention `GenIndexTerm` itself follows.
- GenIndexTermMap
- Every genindex term collected project-wide, keyed by its normalized term
text. Passed between {@see IndexEntryCollector}, {@see GenIndexSeeResolver},
{@see GenIndexTermMapFilter} and {@see GenIndexNodeBuilder} as they collect,
resolve, scope and render it in turn.
- GenIndexTermMapFilter
- Restricts a (already see-resolved) term map to rows originating from a
document under one of a set of path prefixes -- used for a `.. genindex::`
directive's `:scope:` option.
- IndexEntryCollector
- Walks every document for `.. index::` entries and expands each one into
term/subterm rows, following Sphinx's `pair`/`triple`/`module` conventions.
- IndexTargetRegistrar
- Makes a named `.. index::` block a target a `:ref:` can link to.