1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
# docstring-to-markdown
[](https://github.com/python-lsp/docstring-to-markdown/actions?query=workflow%3A%22tests%22)
[](https://python.org/pypi/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
```bash
pip install docstring-to-markdown
```
### Example
Convert reStructuredText:
```python
>>> import docstring_to_markdown
>>> docstring_to_markdown.convert(':math:`\\sum`')
'$\\sum$'
```
When given the format cannot be recognised an exception will be raised:
```python
>>> docstring_to_markdown.convert('\\sum')
Traceback (most recent call last):
raise UnknownFormatError()
docstring_to_markdown.UnknownFormatError
```
### Development
```bash
pip install -e .
pytest
```
|
