a small simple library for generating documentation from docstrings
Project description
inkpot
a small simple library for generating documentation from docstrings
inkpot is available on pip. Please give it a star if you like it!
Installation
pip install inkpot
Usage
python3 -m inkpot myfile.py
or to a file
python3 -m inkpot myfile.py > doc.md
Currently this returns a markdown table. More functionality and a better format will be added.
License
This project is licensed under the MIT License - see the LICENSE file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
inkpot-0.1.2.tar.gz
(2.8 kB
view hashes)
Built Distribution
inkpot-0.1.2-py3-none-any.whl
(3.2 kB
view hashes)