RenderPage(
layout_obj,
renderer,
level=1,
show_title=True,
show_signature=True,
show_description=True,
show_body=True
)Extend Rendering of a layout.Page object
Parameter Attributes
layout_obj: (
layout.DocClass
| layout.DocFunction
| layout.DocAttribute
| layout.DocModule
| layout.Page
| layout.Section
| layout.Link
| layout.Layout
)-
Layout object to be documented
renderer: QRenderer-
Renderer that holds the configured values
level: int = 1-
The depth of the object in the documentation
show_title: bool = True-
Whether to show the title of the object
show_signature: bool = True-
Whether to show the signature
This only applies to objects that have signatures
show_description: bool = True-
Whether to show the description of the object
This only applies to objects that have descriptions that are not considered part of the body documentation body.
This attribute is not well defined and it may change in the future.
show_body: bool = True-
Whether to show the documentation body of the object
Attributes
| Name | Description |
|---|---|
| body | The body that the documented object |
| description | The description that the documented object |
| signature | The signature of the object (if any) |
| summary | The summary of the documented object |
| title | The title/header of a docstring, including any anchors |
body : BlockContent
The body that the documented object
Do not override this property.
description : BlockContent
The description that the documented object
Do not override this property.
signature : BlockContent
The signature of the object (if any)
Do not override this property.
summary
The summary of the documented object
Do not override this property.
title : BlockContent
The title/header of a docstring, including any anchors
Do not override this property.
Methods
| Name | Description |
|---|---|
| render_body | Render the body of the documentation page |
| render_description | Render the description of the documentation page |
| render_signature | Render the signature of the object being documented |
| render_title | Render the title/header of a docstring, including any anchors |
render_body()Render the body of the documentation page
render_description()Render the description of the documentation page
render_signature()Render the signature of the object being documented
render_title()Render the title/header of a docstring, including any anchors