1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
|
# Griffe TypingDoc
[](https://github.com/mkdocstrings/griffe-typingdoc/actions?query=workflow%3Aci)
[](https://mkdocstrings.github.io/griffe-typingdoc/)
[](https://pypi.org/project/griffe-typingdoc/)
[](https://app.gitter.im/#/room/#griffe-typingdoc:gitter.im)
Griffe extension for [PEP 727 – Documentation Metadata in Typing](https://peps.python.org/pep-0727/).
## Installation
```bash
pip install griffe-typingdoc
```
To use the extension in a MkDocs project,
use this configuration:
```yaml
# mkdocs.yml
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_typingdoc
```
|