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
1 maintainer
Metadata
1 maintainer
Release files for inkpot 2.2.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| inkpot-2.2.7.tar.gz | 14.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| inkpot-2.2.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 27.9 kB
Release files / inkpot-2.2.7.tar.gz
| Download URL | inkpot-2.2.7.tar.gz |
|---|---|
| Size | 14.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5e96c79a0fe3adc491a80248d2ccb18b8f131ddedba4b3d9cd14e39465617870
|
|
BLAKE2b-256 checksum How to use checksums |
3b4e153bceb2e59f58ee010dcf339ccdff4bc3a7ef027d8c2f623ef149fe78f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.11.4
|
Release files / inkpot-2.2.7-py3-none-any.whl
| Download URL | inkpot-2.2.7-py3-none-any.whl |
|---|---|
| Size | 14.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cc180a8ab7355d427512b994ff90907795774b5fe1cfedf97902dc4c5fcf99c6
|
|
BLAKE2b-256 checksum How to use checksums |
d6b55c5c2a0e425a83bc03bcb8c3d6b99f3f183dd30f50cd1b0cd6add8ec7634
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.11.4
|
