Official extensions¤
Official extensions are developed and maintained within the mkdocstrings organization on GitHub, in separated repositories. They generally bring support for various third-party libraries or other documentation-related features that are part of Python's standard library.
| Extension | Description | Sponsors only? |
|---|---|---|
autodocstringstyle | Set docstring style to auto for external packages. | |
inherited-docstrings | Inherit docstrings from parent classes. | |
public-redundant-aliases | Mark objects imported with redundant aliases as public. | |
public-wildcard-imports | Mark wildcard imported objects as public. | |
pydantic | Support for Pydantic models. | |
runtime-objects | Access runtime objects corresponding to each loaded Griffe object through their extra attribute. | |
sphinx | Parse Sphinx-comments above attributes (#:) as docstrings. | |
typing-doc | Support for PEP 727's typing.Doc, "Documentation in Annotated Metadata". | |
warnings-deprecated | Support for PEP 702's warnings.deprecated, "Marking deprecations using the type system". |