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!
To know more about way I started this project checkout this blog post
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.
License
This project is licensed under the MIT License - see the LICENSE file for 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.3.0.tar.gz
(3.4 kB
view hashes)
Built Distribution
inkpot-0.3.0-py3-none-any.whl
(4.2 kB
view hashes)
