# 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://app.gitter.im/#/room/#docstrings2pep727:gitter.im)

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
```