README.md

docstring-to-markdown

On the fly conversion of Python docstrings to markdown

• Python 3.6+ (tested on 3.7 up to 3.11)
• can recognise reStructuredText and convert multiple of its features to Markdown
• since v0.13 includes initial support for Google-formatted docstrings

Installation

pip install docstring-to-markdown

Example

Convert reStructuredText:

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

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

>>> docstring_to_markdown.convert('\\sum')
Traceback (most recent call last):
    raise UnknownFormatError()
docstring_to_markdown.UnknownFormatError

Development

pip install -e .
pytest