Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# `autodoc2.render.base`

## Module Contents

### Classes

`RendererBase` |

### 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)

  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
  get_item(full_name: str) → autodoc2.utils.ItemData | None
  get_children(item: autodoc2.utils.ItemData, types: None | set[str] = None, *, omit_hidden: bool = True) → Iterable[autodoc2.utils.ItemData]
  is_hidden(item: autodoc2.utils.ItemData) → bool
  is_module_deprecated(item: autodoc2.utils.ItemData) → bool
  no_index(item: autodoc2.utils.ItemData) → bool
  show_module_summary(item: autodoc2.utils.ItemData) → bool
  show_class_inheritance(item: autodoc2.utils.ItemData) → bool
  show_annotations(item: autodoc2.utils.ItemData) → bool
  show_docstring(item: autodoc2.utils.ItemData) → bool
  abstract render_item(full_name: str) → Iterable[str]
  format_args(args_info: autodoc2.utils.ARGS_TYPE, include_annotations: bool = True, ignore_self: None | str = None) → str
  format_annotation(annotation: None | str) → str
  format_base(base: None | str) → str
  get_doc_parser(full_name: str) → str
  abstract generate_summary(objects: list[autodoc2.utils.ItemData], alias: dict[str, str] | None = None) → Iterable[str]