Project description

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

pip install docstring-to-markdown

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')
UnknownFormatError()

pip install -e .
pytest

Algorithm	Hash digest
SHA256	`fc7c189c71ea5104de31a8a2cfd0d27c51f7e7099ffe226bee23ba15fc218208`
MD5	`401d3a675c2f3c12f8f959af946fd601`
BLAKE2b-256	`f4245e039cbe7bc3e97982af29d8d95b2e7f606e46cb2717ab1b01951613672f`

Algorithm	Hash digest
SHA256	`02cdf914c8d63b0129a18edcb0038e529f0fcc6e6b52212954616b99df5695e7`
MD5	`972eb998da5f30e9001fac2e1d875ca6`
BLAKE2b-256	`b7d5605df31ff12474ad2b5f68dcdcfcab3cc4ccd47d4bd4df6feae113907191`