Key Features
- Fully Automated: Generates complete API documentation directly from your Django repository, requiring no manual effort.
- Easy to Use: Simply run
knowl_apidocs <path_to_your_Django_repository>, and your API documentation will be ready in theapi-referencefolder. - No Prerequisites Needed: All necessary components are installed along with
knowl-apidocs. - Python Compatibility: Supports Python version 3.9 and above.
Getting Started
- Install knowl-apidocs via pip:
pip install knowl-apidocs
- Generate your API documentation:
knowl_apidocs <path_to_your_Django_repository>
Check the api-reference folder in your project directory for the generated documentation.
Support and Contributions
- For open issues or specific requests regarding API documentation, visit our GitHub issues.
- Need help or have questions? Contact us at support@knowl.io.
Start simplifying your API documentation process with knowl-apidocs today!
Metadata
Release files for knowl-apidocs 0.2.16.36
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| knowl_apidocs-0.2.16.36.tar.gz | 6.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| knowl_apidocs-0.2.16.36-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.6 kB
Release files / knowl_apidocs-0.2.16.36.tar.gz
| Download URL | knowl_apidocs-0.2.16.36.tar.gz |
|---|---|
| Size | 6.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
13516cab351ed10ef6feb404640e487d7f2c58784206f8bf54501dfb34871a1c
|
|
BLAKE2b-256 checksum How to use checksums |
1ce0e342f384e260e04a94710837e92944125e7b6ce68b132d9028d31118fa0c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.8
|
Release files / knowl_apidocs-0.2.16.36-py3-none-any.whl
| Download URL | knowl_apidocs-0.2.16.36-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8a9d95cc40f2dc9184bffef908f42eb26ec31003b73723e0acef4382d41fed42
|
|
BLAKE2b-256 checksum How to use checksums |
b16145920e473960e1f4d8b583747a3d3079a62d1fe1dadd347a00ebc681252e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.11.8
|