qrenderer.QRenderer

QRenderer(
    header_level=1,
    show_signature=True,
    display_name_format="auto",
    signature_name_format="name",
    typing_module_paths=list()
)

Render strings to markdown

This class provides a scafolding around quartodocs base renderer and it helps connect the rendering done by this package to the official quartodoc renderer API.

Parameter Attributes

header_level: int = 1

show_signature: bool = True

display_name_format: DisplayNameFormat | Literal["auto"] = "auto"

signature_name_format: DisplayNameFormat = "name"

typing_module_paths: list[str] = field(default_factory=list)

See Also

extend_base_class

Methods

Name	Description
render	Render a page
summarize	Summarize a Layout

render

render(el)

Render a page

summarize

summarize(el)

Summarize a Layout

A Layout consists of a sequence of layout sections and/or layout pages