inkpot
a small simple library for generating documentation from docstrings
Installation
pip install inkpot
Usage
singel file
python3 -m inkpot myfile.py
or directory
python3 -m inkpot myproject/
output to a file (also works with directories)
python3 -m inkpot myfile.py > doc.md
python3 -m inkpot myproject/ > doc.md
Currently this returns a markdown table. More functionality and a better format will be added.
Example
Python file ex/add.py
def add(a,b):
""" add to objects """
return a + b
python3 -m inkpot ex/add.py
returns markdown
# ex/add.py
## ex/add.py
| type | name | doc-str |
|:-------|:-------|:---------------|
| def | add | add to objects |
| module | add | None |
