1a:T6c8,

docstring-to-markdown

On the fly conversion of Python docstrings to markdown

Python 3.7+ (tested on 3.8 up to 3.13)
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

Extensibility

docstring_to_markdown entry point group allows to add custom converters which follow the Converter protocol.
The built-in converters can be customized by providing entry point with matching name.

Development

pip install -e .
pytest

19:["$","div",null,{"className":"markdown-content max-w-2xl","dangerouslySetInnerHTML":{"__html":"$1a"}}]

Dependencies of docstring-to-markdown (2).
Dependency	Optional
importlib-metadata	false
typing_extensions	false

Package profile

docstring-to-markdown

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description