Initial commit

Author: krassowski

README.md

@@ -1,2 +1,38 @@
 # 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
+
+```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')
+UnknownFormatError()
+```
+
+### Development
+
+```bash
+pip install -e .
+pytest
+```

docstring_to_markdown/__init__.py

@@ -0,0 +1,11 @@
+from .rst import looks_like_rst, rst_to_markdown
+
+
+class UnknownFormatError(Exception):
+    pass
+
+
+def convert(docstring: str) -> str:
+    if looks_like_rst(docstring):
+        return rst_to_markdown(docstring)
+    raise UnknownFormatError()