Metadata-Version: 2.1
Name: griffe-typingdoc
Version: 0.2.0
Summary: Griffe extension for PEP 727 – Documentation Metadata in Typing.
Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
License: ISC
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://mkdocstrings.github.io/griffe-typingdoc
Project-URL: Documentation, https://mkdocstrings.github.io/griffe-typingdoc
Project-URL: Changelog, https://mkdocstrings.github.io/griffe-typingdoc/changelog
Project-URL: Repository, https://github.com/mkdocstrings/griffe-typingdoc
Project-URL: Issues, https://github.com/mkdocstrings/griffe-typingdoc/issues
Project-URL: Discussions, https://github.com/mkdocstrings/griffe-typingdoc/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-typingdoc
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.8
Requires-Dist: griffe>=0.35
Requires-Dist: typing-extensions>=4.7
Description-Content-Type: text/markdown

# Griffe TypingDoc

[![ci](https://github.com/mkdocstrings/griffe-typingdoc/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-typingdoc/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/griffe-typingdoc/)
[![pypi version](https://img.shields.io/pypi/v/griffe-typingdoc.svg)](https://pypi.org/project/griffe-typingdoc/)
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-typingdoc)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://gitter.im/mkdocstrings/griffe-typingdoc)

Griffe extension for [PEP 727 – Documentation Metadata in Typing](https://peps.python.org/pep-0727/).

## Installation

With `pip`:
```bash
pip install griffe-typingdoc
```

With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.8 -m pip install --user pipx
pipx 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
```
