File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 77On the fly conversion of Python docstrings to markdown
88
99- Python 3.6+
10- - currently can recognise reStructuredText and convert multiple of its features to Markdown
11- - in the future will be able to convert Google docstrings too
10+ - can recognise reStructuredText and convert multiple of its features to Markdown
11+ - since v0.13 includes initial support for Google-formatted docstrings
1212
1313### Installation
1414
1515``` bash
1616pip install docstring-to-markdown
1717```
1818
19-
2019### Example
2120
2221Convert reStructuredText:
Original file line number Diff line number Diff line change 11from .google import google_to_markdown , looks_like_google
22from .rst import looks_like_rst , rst_to_markdown
33
4- __version__ = "0.12 "
4+ __version__ = "0.13 "
55
66
77class UnknownFormatError (Exception ):
You can’t perform that action at this time.
0 commit comments