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.1.tar.gz
(14.2 kB
view details)
Built Distribution
File details
Details for the file docstring-to-markdown-0.1.tar.gz.
File metadata
- Download URL: docstring-to-markdown-0.1.tar.gz
- Upload date:
- Size: 14.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fc7c189c71ea5104de31a8a2cfd0d27c51f7e7099ffe226bee23ba15fc218208 |
|
| MD5 | 401d3a675c2f3c12f8f959af946fd601 |
|
| BLAKE2b-256 | f4245e039cbe7bc3e97982af29d8d95b2e7f606e46cb2717ab1b01951613672f |
File details
Details for the file docstring_to_markdown-0.1-py3-none-any.whl.
File metadata
- Download URL: docstring_to_markdown-0.1-py3-none-any.whl
- Upload date:
- Size: 15.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 02cdf914c8d63b0129a18edcb0038e529f0fcc6e6b52212954616b99df5695e7 |
|
| MD5 | 972eb998da5f30e9001fac2e1d875ca6 |
|
| BLAKE2b-256 | b7d5605df31ff12474ad2b5f68dcdcfcab3cc4ccd47d4bd4df6feae113907191 |
