# rendering.FunctionRenderer

The presentation of a function or method, with its signature and docstring sections

Usage

[Source](https://github.com/posit-dev/great-docs/blob/main/great_docs/_apiref/_rendering/functions.py#L16-L29)

``` python
rendering.FunctionRenderer(
    node,
    level=1,
    contained=False,
    page_path=None,
    display_name_format="doc",
    signature_name_format="doc",
    *,
    renderers=_default_renderers(),
    extension=_default_extension(),
    context_page_path=None,
    _purpose=_RenderingPurpose.OBJECT,
)
```

The description shows the subject, then the Usage and source row and the signature; the docstring body follows. Override the signature or section methods to change how they render; the prepared documentation stays unchanged.

## 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

`contained: bool = False`  
Whether this object is documented inside another object's documentation

A contained member's summary row links to its heading on the same page, and its [context](../reference/great_docs.rendering.ObjectRenderer.context.md) reports the containing page.

`page_path: str | None = None`  
The page that this object's summary row links to

API pages supply a path relative to the reference directory. `None` links within the current page, and contained members always link to a local anchor. For the containing page relative to the output directory, use `context.page_path`.

`display_name_format: DisplayNameFormat = "doc"`  
Format for the display name

`signature_name_format: DisplayNameFormat = "doc"`  
Format for the signature name

`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

`_purpose: _RenderingPurpose = _RenderingPurpose.OBJECT`  

## Methods

| Name | Description |
|----|----|
| [\_\_post_init\_\_()](#great_docs.rendering.FunctionRenderer.__post_init__) | Narrow `doc` and [obj](../reference/rendering.RenderContext.md#great_docs._apiref._rendering._context.RenderContext.obj) to function documentation |

### \_\_post_init\_\_()

Narrow `doc` and [obj](../reference/rendering.RenderContext.md#great_docs._apiref._rendering._context.RenderContext.obj) to function documentation

Usage

[Source](https://github.com/posit-dev/great-docs/blob/main/great_docs/_apiref/_rendering/functions.py#L25-L29)

``` python
__post_init__()
```
