Metadata-Version: 2.1
Name: docstring-to-markdown
Version: 0.1
Summary: On the fly conversion of Python docstrings to markdown
Home-page: UNKNOWN
Author: Michał Krassowski
Author-email: krassowski.michal+pypi@gmail.com
License: LGPL-2.1
Project-URL: Bug Tracker, https://github.com/krassowski/docstring-to-markdown/issues
Project-URL: Source Code, https://github.com/krassowski/docstring-to-markdown
Keywords: Docstring,conversion,markdown
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Programming Language :: Python
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# docstring-to-markdown

On the fly conversion of Python docstrings to markdown

- Python 3.6+
- currently can recognise reStructuredText and convert multiple of its features to Markdown
- in the future will be able to convert Google docstrings too

### Installation

```bash
pip install docstring-to-markdown
```


### Example

Convert reStructuredText:

```python
>>> import docstring_to_markdown
>>> docstring_to_markdown.convert(':math:`\\sum`')
$\\sum$
```

When given the format cannot be recognised an exception will be raised:

```python
>>> docstring_to_markdown.convert('\\sum')
UnknownFormatError()
```

### Development

```bash
pip install -e .
pytest
```


