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 11# docstring-to-markdown
22
33[ ![ 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 )
46
57On the fly conversion of Python docstrings to markdown
68
@@ -22,14 +24,16 @@ Convert reStructuredText:
2224``` python
2325>> > import docstring_to_markdown
2426>> > docstring_to_markdown.convert(' :math:`\\ sum`' )
25- $ \\sum$
27+ ' $\\ sum$'
2628```
2729
2830When given the format cannot be recognised an exception will be raised:
2931
3032``` python
3133>> > docstring_to_markdown.convert(' \\ sum' )
32- UnknownFormatError()
34+ Traceback (most recent call last):
35+ raise UnknownFormatError()
36+ docstring_to_markdown.UnknownFormatError
3337```
3438
3539### Development
You can’t perform that action at this time.
0 commit comments