rendering.ModuleRenderer
The presentation of a module, with a name declaration and member groups
Usage
rendering.ModuleRenderer(
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 name declaration, then the Usage and source row and the subject. The body shows the docstring sections followed by member groups. A module’s signature is its name, without parameters.
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 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.
Nonelinks within the current page, and contained members always link to a local anchor. For the containing page relative to the output directory, usecontext.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__() | Narrow doc and obj to module documentation |
| render_signature() | Render the module name declaration, or return None for an empty name |
__post_init__()
Narrow doc and obj to module documentation
Usage
__post_init__()render_signature()
Render the module name declaration, or return None for an empty name
Usage
render_signature()Returns
BlockContent-
The name as code in a
doc-signaturedivision, orNonefor an empty name.