# rendering.ObjectRenderer

The presentation of one prepared Python object or authored alias

Usage

[Source](https://github.com/posit-dev/great-docs/blob/main/great_docs/_apiref/_rendering/objects.py#L94-L1001)

``` python
rendering.ObjectRenderer(
    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 heading, lead content and body each have their own render method. Each object kind sets the order of its signature and subject, and kinds with members add member groups after the object's own docstring. Use [context](../reference/great_docs.rendering.ObjectRenderer.context.md) to customise a particular appearance.

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

## Attributes

| Name | Description |
|----|----|
| [summary_name](great_docs.rendering.ObjectRenderer.summary_name.md) | The authored name shown in this object's summary row |

## Functions

| Name | Description |
|----|----|
| [\_\_post_init\_\_()](great_docs.rendering.ObjectRenderer.__post_init__.md) | Expose the documentation node as `doc` and its prepared Python object as [obj](../reference/rendering.RenderContext.md#great_docs._apiref._rendering._context.RenderContext.obj) |
| [\_\_str\_\_()](great_docs.rendering.ObjectRenderer.__str__.md) | Include the published link target alongside the native heading ID |
| [context()](great_docs.rendering.ObjectRenderer.context.md) | The frozen record of this object's appearance |
| [display_name()](great_docs.rendering.ObjectRenderer.display_name.md) | The Markdown-escaped name shown in the heading |
| [docstring_sections()](great_docs.rendering.ObjectRenderer.docstring_sections.md) | The rendered docstring sections, omitting empty ones |
| [docstring_sections_content()](great_docs.rendering.ObjectRenderer.docstring_sections_content.md) | The title and prepared section of each docstring section after the subject |
| [docstring_subject()](great_docs.rendering.ObjectRenderer.docstring_subject.md) | The first paragraph of the docstring, on one line, shown as the subject |
| [kind()](great_docs.rendering.ObjectRenderer.kind.md) | The object's kind |
| [kind_slug()](great_docs.rendering.ObjectRenderer.kind_slug.md) | The object's kind as a CSS class slug |
| [label()](great_docs.rendering.ObjectRenderer.label.md) | The lower-case kind label used in the CSS classes of headings and summary rows |
| [render_admonition_section()](great_docs.rendering.ObjectRenderer.render_admonition_section.md) | Render the descriptive content of an additional numpydoc section |
| [render_annotation()](great_docs.rendering.ObjectRenderer.render_annotation.md) | Render an annotation as highlighted inline content |
| [render_body()](great_docs.rendering.ObjectRenderer.render_body.md) | Render the object's docstring body |
| [render_classes_section()](great_docs.rendering.ObjectRenderer.render_classes_section.md) | Omit a hand-written `Classes` summary |
| [render_definition_items()](great_docs.rendering.ObjectRenderer.render_definition_items.md) | Render a section's definitions with their names, annotations, defaults and descriptions |
| [render_deprecated_section()](great_docs.rendering.ObjectRenderer.render_deprecated_section.md) | Render a `Deprecated` section |
| [render_description()](great_docs.rendering.ObjectRenderer.render_description.md) | Render the signature, the Usage and source row, and the subject, in that order |
| [render_docstring_body()](great_docs.rendering.ObjectRenderer.render_docstring_body.md) | Render the docstring sections that follow the subject |
| [render_docstring_section()](great_docs.rendering.ObjectRenderer.render_docstring_section.md) | Render one docstring section with the method for its kind |
| [render_docstring_subject()](great_docs.rendering.ObjectRenderer.render_docstring_subject.md) | Render the subject of the docstring |
| [render_examples_section()](great_docs.rendering.ObjectRenderer.render_examples_section.md) | Render an `Examples` section |
| [render_functions_section()](great_docs.rendering.ObjectRenderer.render_functions_section.md) | Omit hand-written `Functions` and `Methods` summaries |
| [render_modules_section()](great_docs.rendering.ObjectRenderer.render_modules_section.md) | Omit a hand-written `Modules` summary |
| [render_notes_section()](great_docs.rendering.ObjectRenderer.render_notes_section.md) | Render a `Notes` section |
| [render_see_also_section()](great_docs.rendering.ObjectRenderer.render_see_also_section.md) | Render a `See Also` section |
| [render_signature()](great_docs.rendering.ObjectRenderer.render_signature.md) | Render the object declaration, or return `None` to omit it |
| [render_summary()](great_docs.rendering.ObjectRenderer.render_summary.md) | Render one summary row that links `summary_name` and shows the subject |
| [render_text_section()](great_docs.rendering.ObjectRenderer.render_text_section.md) | Render a `Text` section |
| [render_title()](great_docs.rendering.ObjectRenderer.render_title.md) | Render the heading that holds [title_content](../reference/great_docs.rendering.ObjectRenderer.title_content.md), or return `None` to omit it |
| [render_title_content()](great_docs.rendering.ObjectRenderer.render_title_content.md) | Render the object's display name and labels as inline text |
| [render_type_aliases_section()](great_docs.rendering.ObjectRenderer.render_type_aliases_section.md) | Omit a hand-written `Type Aliases` summary |
| [render_usage_source()](great_docs.rendering.ObjectRenderer.render_usage_source.md) | Render the Usage label and the source link, or `None` when neither applies |
| [render_variable_definition()](great_docs.rendering.ObjectRenderer.render_variable_definition.md) | Render a variable or parameter declaration as inline markup |
| [render_warnings_section()](great_docs.rendering.ObjectRenderer.render_warnings_section.md) | Render a `Warnings` section |
| [signature()](great_docs.rendering.ObjectRenderer.signature.md) | The signature from `render_signature`, cached once per renderer instance |
| [signature_name()](great_docs.rendering.ObjectRenderer.signature_name.md) | The name shown in the signature, formatted by [signature_name_format](../reference/rendering.ObjectRenderer.md#great_docs.rendering.ObjectRenderer.signature_name_format) |
| [source_link()](great_docs.rendering.ObjectRenderer.source_link.md) | The link to the object's source, or `None` without one |
| [title_content()](great_docs.rendering.ObjectRenderer.title_content.md) | The object's labelled name as inline text |
