autodoc2.render.base

Module Contents

Classes

API

class autodoc2.render.base.RendererBase(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: abc.ABC

Initialization

EXTENSION: ClassVar[str] = '.txt'
_is_hidden_cache: collections.OrderedDict[str, bool] = None
property config: autodoc2.config.Config
property standalone: bool
warn(msg: str, type_: autodoc2.utils.WarningSubtypes = WarningSubtypes.RENDER_ERROR) None[source]
get_item(full_name: str) autodoc2.utils.ItemData | None[source]
get_children(item: autodoc2.utils.ItemData, types: None | set[str] = None, *, omit_hidden: bool = True) Iterable[autodoc2.utils.ItemData][source]
is_hidden(item: autodoc2.utils.ItemData) bool[source]
is_module_deprecated(item: autodoc2.utils.ItemData) bool[source]
no_index(item: autodoc2.utils.ItemData) bool[source]
show_module_summary(item: autodoc2.utils.ItemData) bool[source]
show_class_inheritance(item: autodoc2.utils.ItemData) bool[source]
show_annotations(item: autodoc2.utils.ItemData) bool[source]
show_docstring(item: autodoc2.utils.ItemData) bool[source]
abstractmethod render_item(full_name: str) Iterable[str][source]
format_args(args_info: autodoc2.utils.ARGS_TYPE, include_annotations: bool = True, ignore_self: None | str = None) str[source]
format_annotation(annotation: None | str) str[source]
format_base(base: None | str) str[source]
get_doc_parser(full_name: str) str[source]
abstractmethod generate_summary(objects: list[autodoc2.utils.ItemData], alias: dict[str, str] | None = None) Iterable[str][source]