File tree Expand file tree Collapse file tree 1 file changed +6
-2
lines changed Expand file tree Collapse file tree 1 file changed +6
-2
lines changed Original file line number Diff line number Diff line change 1
1
# docstring-to-markdown
2
2
3
3
[ ![ tests] ( https://github.com/krassowski/jupyterlab-lsp/workflows/tests/badge.svg )] ( https://github.com/krassowski/docstring-to-markdown/actions?query=workflow%3A%22tests%22 )
4
+ ![ CodeQL] ( https://github.com/krassowski/data-vault/workflows/CodeQL/badge.svg )
5
+ [ ![ pypi-version] ( https://img.shields.io/pypi/v/docstring-to-markdown.svg )] ( https://python.org/pypi/docstring-to-markdown )
4
6
5
7
On the fly conversion of Python docstrings to markdown
6
8
@@ -22,14 +24,16 @@ Convert reStructuredText:
22
24
``` python
23
25
>> > import docstring_to_markdown
24
26
>> > docstring_to_markdown.convert(' :math:`\\ sum`' )
25
- $ \\sum$
27
+ ' $\\ sum$'
26
28
```
27
29
28
30
When given the format cannot be recognised an exception will be raised:
29
31
30
32
``` python
31
33
>> > docstring_to_markdown.convert(' \\ sum' )
32
- UnknownFormatError()
34
+ Traceback (most recent call last):
35
+ raise UnknownFormatError()
36
+ docstring_to_markdown.UnknownFormatError
33
37
```
34
38
35
39
### Development
You can’t perform that action at this time.
0 commit comments