Skip to main content

__init__()

Set up the index for a reference and its resolved sections

Usage

Source

__init__(
    api_ref,
    sections,
    level=1,
    *,
    renderers=None,
)

Parameters

api_ref: APIReference

The reference that supplies the title, description, extension and default renderer choices.

sections: list[Section]

Resolved top-level sections in the order to display.

level: int = 1

Base heading depth for section titles and subtitles.

renderers: Renderers | None = None
The renderer choices to use, or None for the reference’s own.