rendering.Renderers
The renderer classes to use for each kind of object and page
Usage
rendering.Renderers(
*,
classes=None,
functions=None,
attributes=None,
type_aliases=None,
modules=None,
api_pages=None,
reference_index=None,
reference_sections=None,
object_renderer_mixin=None,
)A kind left out uses the built-in renderer. object_renderer_mixin comes before each default object renderer in its method resolution order, while a replacement renderer chooses its own base classes. Defining or selecting a subclass never changes the built-in classes. Nested pages, members and summaries use the same choices.
Parameters
classes: type[ClassRenderer] | None = None-
The renderer for classes.
functions: type[FunctionRenderer] | None = None-
The renderer for functions and methods.
attributes: type[AttributeRenderer] | None = None-
The renderer for attributes, properties and PEP 613 type aliases.
type_aliases: type[TypeAliasRenderer] | None = None-
The renderer for PEP 695 type aliases.
modules: type[ModuleRenderer] | None = None-
The renderer for modules.
api_pages: type[APIPageRenderer] | None = None-
The renderer for pages that document one or more objects.
reference_index: type[ReferenceIndexRenderer] | None = None-
The renderer for the whole reference index.
reference_sections: type[ReferenceSectionRenderer] | None = None-
The renderer for each section of the reference index.
object_renderer_mixin: type | None = None- A class whose methods apply to every default object renderer. A replacement renderer gets them only by inheriting from the mixin. Page and section renderers never get them.
Raises
TypeError- If a replacement does not subclass the matching built-in renderer, or the mixin is not a class.
Methods
| Name | Description |
|---|---|
| __init__() | Validate the replacements and use the default renderer for each kind left out |
| make() | Construct the selected renderer for a node and pass these choices on |
__init__()
Validate the replacements and use the default renderer for each kind left out
Usage
__init__(
*,
classes=None,
functions=None,
attributes=None,
type_aliases=None,
modules=None,
api_pages=None,
reference_index=None,
reference_sections=None,
object_renderer_mixin=None,
)make()
Construct the selected renderer for a node and pass these choices on
Usage
make(
self,
node: DocClass,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> ClassRenderer
make(
self,
node: DocFunction,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> FunctionRenderer
make(
self,
node: DocAttribute,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> AttributeRenderer
make(
self,
node: DocTypeAlias,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> TypeAliasRenderer
make(
self,
node: DocModule,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> ModuleRenderer
make(
self,
node: Page,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> APIPageRenderer
make(
self,
node: Section,
level: int = 1,
extension: Extension | None = None,
kwargs: Any = {},
) -> ReferenceSectionRenderer
make(
self,
node: APIReference,
level: int = 1,
sections: list[Section],
kwargs: Any = {},
) -> ReferenceIndexRendererParameters
node: Documentable | APIReference-
The prepared object, resolved page or section, or reference index to render.
level: int = 1-
The heading depth of this appearance.
extension: Extension | None = None-
The extension that supplies settings and project directories, or
Nonefor default settings. A reference index uses its reference’s extension. sections: list[Section] | None = None-
The resolved sections, which a reference index requires and every other kind of node rejects.
**kwargs: Any-
Further constructor arguments for the selected renderer, such as an object’s summary-link
page_path, itscontainedstate, or the context_page_path of its containing page relative to the output directory.
Returns
BaseRenderer- A renderer whose nested appearances use the same choices.
Raises
TypeError-
If index sections are absent, sections are supplied to another kind, or constructor arguments are invalid.
ValueError- If the node kind is unsupported.