On the fly conversion of Python docstrings to markdown
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
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')
UnknownFormatError()
Development
pip install -e .
pytest
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docstring-to-markdown-0.3.tar.gz
(15.0 kB
view details)
Built Distribution
File details
Details for the file docstring-to-markdown-0.3.tar.gz.
File metadata
- Download URL: docstring-to-markdown-0.3.tar.gz
- Upload date:
- Size: 15.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | af352323eb1ae59e29634f972259a6c8e71ee249731359dd274b6c8b30107be7 |
|
| MD5 | bb74566807081f8f33af36b9d32693dc |
|
| BLAKE2b-256 | 5d86990a8cda61e61dcf5f5a33c97e4b83285daf642da5f0cfc065639105644a |
File details
Details for the file docstring_to_markdown-0.3-py3-none-any.whl.
File metadata
- Download URL: docstring_to_markdown-0.3-py3-none-any.whl
- Upload date:
- Size: 15.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5844f9149214385246425fd948e065565a859f113670d38251e0a9175b0d02cd |
|
| MD5 | 37c3f795217c616088a8410d4fb77942 |
|
| BLAKE2b-256 | 3457e18ebc2ba5724c7fdd4fb2f7ce2d396a9fa1c36a9799cc1cd6073aa1bf43 |
