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.
pip install inkpot
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.
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 `
This project is licensed under the MIT License - see the LICENSE file for details
A special thanks to:
FAQs
a small simple library for generating documentation from docstrings
We found that inkpot demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.