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

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

  Bases: `autodoc2.render.base.RendererBase`

  Initialization

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