# rendering.BaseRenderer

The common base of object, page and section renderers

Usage

[Source](https://github.com/posit-dev/great-docs/blob/main/great_docs/_apiref/_rendering/base.py#L61-L264)

``` python
rendering.BaseRenderer(
    node,
    level=1,
    *,
    renderers=_default_renderers(),
    extension=_default_extension(),
    context_page_path=None,
)
```

An object renderer renders a heading and a docstring; a page renderer renders front matter and the objects on the page; a section renderer renders linked summaries. Each renderer renders its title, description, body and summary once and caches them. To change one, override the matching `render_*` method, and return `None` from a method that renders a block to omit that block.

## Parameter Attributes

`node: (     APIReference     | content.DocClass     | content.DocFunction     | content.DocAttribute     | content.DocTypeAlias     | content.DocModule     | content.Page     | content.Section )`  
The node being documented

`level: int = 1`  
The heading depth of this appearance

`renderers: Renderers = _default_renderers()`  
Renderer choices shared with nested objects, pages and summaries

`extension: Extension = _default_extension()`  
The extension that supplies settings and project directories

A standalone renderer uses default settings and has no project directories.

`context_page_path: str | None = None`  
The containing page's path relative to the output directory, apart from summary links

## Attributes

| Name | Description |
|----|----|
| [output_root](great_docs.rendering.BaseRenderer.output_root.md) | The directory the documentation is generated into, or `None` outside a build |
| [settings](great_docs.rendering.BaseRenderer.settings.md) | The settings of the API reference being rendered |
| [summary_name](great_docs.rendering.BaseRenderer.summary_name.md) | The label in linked summaries, which the base renderer leaves empty |

## Functions

| Name | Description |
|----|----|
| [\_\_post_init\_\_()](great_docs.rendering.BaseRenderer.__post_init__.md) | End the chain of `super().__post_init__()` calls from subclasses and mixins |
| [\_\_str\_\_()](great_docs.rendering.BaseRenderer.__str__.md) | Compose the cached title, description and body as Quarto Markdown |
| [body()](great_docs.rendering.BaseRenderer.body.md) | The body, rendered once per renderer and cached |
| [description()](great_docs.rendering.BaseRenderer.description.md) | The description, rendered once per renderer and cached |
| [make_renderer()](great_docs.rendering.BaseRenderer.make_renderer.md) | Construct a nested renderer with this renderer's choices and context |
| [render_body()](great_docs.rendering.BaseRenderer.render_body.md) | Render the body, or return `None` to omit it |
| [render_description()](great_docs.rendering.BaseRenderer.render_description.md) | Render the description, or return `None` to omit it |
| [render_summary()](great_docs.rendering.BaseRenderer.render_summary.md) | Render linked summary items, or return an empty sequence to omit them |
| [render_title()](great_docs.rendering.BaseRenderer.render_title.md) | Render an object's heading or a page's front matter, or return `None` to omit it |
| [summary()](great_docs.rendering.BaseRenderer.summary.md) | The linked summary items, rendered once per renderer and cached |
| [title()](great_docs.rendering.BaseRenderer.title.md) | The title, rendered once per renderer and cached |
