RendererPage
ClassDataClassSource
RendererPage(
data: DocModule | DocFunction | DocClass | DocDataClass | DocEnum | DocTypedDict | DocProtocol | DocTypeAlias
)
The renderer of the an API page.
Fields
| Name | Type | Required | |
|---|---|---|---|
data | DocModule | DocFunction | DocClass | DocDataClass | DocEnum | DocTypedDict | DocProtocol | DocTypeAlias | The data used for rendering the page. |
Methods
render
v_1: str = self.render()
Render the page as an MDX file.
Returns
| Name | Type | |
|---|---|---|
v_1 | str | The rendered page text in the MDX format. |
Properties
file_path
file_path: str = self.file_path
Get the path of the output file where the page conent supposes to be saved.
id
id: str = self.id
Get the ID of this page.
metadata
metadata: dict[str, str] = self.metadata
The YAML heading containing the docusaurus metadata.
short_descr
short_descr: str = self.short_descr
The short description of the data extracted from the first sentence.
slug
slug: str = self.slug
The documentation address slug.