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.
Available official extensions:
autodocstringstyle
: Set docstring style toauto
for external packages. Sponsors onlyinherited-docstrings
: Inherit docstrings from parent classes.public-redundant-aliases
: Mark objects imported with redundant aliases as public. Sponsors onlypublic-wildcard-imports
: Mark wildcard imported objects as public. Sponsors onlypydantic
: Support for Pydantic models. Sponsors onlyruntime-objects
: Access runtime objects corresponding to each loaded Griffe object through theirextra
attribute. Sponsors onlysphinx
: Parse Sphinx-comments above attributes (#:
) as docstrings. Sponsors onlytyping-doc
: Support for PEP 727'styping.Doc
, "Documentation in Annotated Metadata".warnings-deprecated
: Support for PEP 702'swarnings.deprecated
, "Marking deprecations using the type system". Sponsors only