# rendering.ReferenceIndexRenderer

The reference index page, listing resolved sections

Usage

[Source](https://github.com/posit-dev/great-docs/blob/main/great_docs/_apiref/_rendering/reference_index.py#L31-L126)

``` python
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](great_docs._apiref._rendering.reference_index.ReferenceIndexRenderer.api_ref.md) | The API reference being documented |
| [package](great_docs._apiref._rendering.reference_index.ReferenceIndexRenderer.package.md) | The package being documented |
| [sections](great_docs._apiref._rendering.reference_index.ReferenceIndexRenderer.sections.md) | Resolved top-level sections in authored reference order |

## Functions

| Name | Description |
|----|----|
| [\_\_init\_\_()](great_docs.rendering.ReferenceIndexRenderer.__init__.md) | Set up the index for a reference and its resolved sections |
| [render_body()](great_docs.rendering.ReferenceIndexRenderer.render_body.md) | Render the sections in their authored order |
| [render_description()](great_docs.rendering.ReferenceIndexRenderer.render_description.md) | Render the description of the reference page |
| [render_metadata()](great_docs.rendering.ReferenceIndexRenderer.render_metadata.md) | Render the reference title, description metadata and index navigation settings |
