autodoc2.render.myst_#

Module Contents#

Classes#

MystRenderer

Data#

_RE_DELIMS

API#

autodoc2.render.myst_._RE_DELIMS = None#
class autodoc2.render.myst_.MystRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, *, warn: Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, all_resolver: autodoc2.resolve_all.AllResolver | None = None, standalone: bool = True)[source]#

Bases: autodoc2.render.base.RendererBase

Initialization

EXTENSION = '.md'#
render_item(full_name: str) → Iterable[str][source]#
generate_summary(objects: list[autodoc2.utils.ItemData], alias: dict[str, str] | None = None) → Iterable[str][source]#
static enclosing_backticks(text: str) → str[source]#
render_package(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_module(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_function(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_exception(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_class(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_property(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_method(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_attribute(item: autodoc2.utils.ItemData) → Iterable[str][source]#
render_data(item: autodoc2.utils.ItemData) → Iterable[str][source]#
_reformat_cls_base_myst(value: str) → str[source]#