rendering.ReferenceIndexRenderer
The reference index page, listing resolved sections
Usage
rendering.ReferenceIndexRenderer(
api_ref,
sections,
level=1,
*,
renderers=None,
)The page title is in the front matter. Each section contributes a heading, a description and summary rows.
Attributes
| Name | Description |
|---|---|
| api_ref | The API reference being documented |
| package | The package being documented |
| sections | Resolved top-level sections in authored reference order |
Functions
| Name | Description |
|---|---|
| __init__() | Set up the index for a reference and its resolved sections |
| render_body() | Render the sections in their authored order |
| render_description() | Render the description of the reference page |
| render_metadata() | Render the reference title, description metadata and index navigation settings |