Skip to content

Griffe TypingDoc¤

ci documentation pypi version gitpod gitter

Griffe extension for PEP 727 – Documentation Metadata in Typing.

Installation¤

With pip:

pip install griffe-typingdoc

With pipx:

python3.8 -m pip install --user pipx
pipx install griffe-typingdoc

To use the extension in a MkDocs project, use this configuration:

# mkdocs.yml
plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_typingdoc