inkpot

A small simple library for generating documentation from docstrings

inkpot is available on pip. Please give it a star if you like it!

To know more about way this project was started, checkout this blog post.

Installation

pip install inkpot

Usage

single 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

More functionality and better formatting might be added.

Example

On the wiki you can se the result of running inkpot on the inkpot source code.

Here is a small example from the test files.

Python file tests/.ex/add.py

def add(a,b):
    """ add to objects """
    return a + b

python3 -m inkpot tests/.ex/add.py

returns markdown

# tests/.ex/add.py
## tests/.ex/add.py
**def add(a, b)** \
`add to objects `

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgement

A special thanks to:

• Astunparse, which is used in inkpot to unparse python files