Metadata-Version: 2.1
Name: docstrings2pep727
Version: 0.1.0
Summary: Move documentation from docstrings to PEP 727 type annotations.
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 :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://pawamoy.github.io/docstrings2pep727
Project-URL: Documentation, https://pawamoy.github.io/docstrings2pep727
Project-URL: Changelog, https://pawamoy.github.io/docstrings2pep727/changelog
Project-URL: Repository, https://github.com/pawamoy/docstrings2pep727
Project-URL: Issues, https://github.com/pawamoy/docstrings2pep727/issues
Project-URL: Discussions, https://github.com/pawamoy/docstrings2pep727/discussions
Project-URL: Gitter, https://gitter.im/docstrings2pep727/community
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.8
Requires-Dist: libcst>=1.0.1
Requires-Dist: griffe>=0.35.2
Description-Content-Type: text/markdown

# docstrings2pep727

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

Move documentation from docstrings to PEP 727 type annotations.

## Installation

With `pip`:
```bash
pip install docstrings2pep727
```

With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.8 -m pip install --user pipx
pipx install docstrings2pep727
```
