Automatically generate comprehensive API documentation for your Python Django projects with **knowl-apidocs**. It's the first tool of its kind, offering a 100% automated solution to create detailed API docs without writing a single line of code.
Project description
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!
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file knowl_apidocs-0.2.16.36.tar.gz.
File metadata
- Download URL: knowl_apidocs-0.2.16.36.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
13516cab351ed10ef6feb404640e487d7f2c58784206f8bf54501dfb34871a1c
|
|
| MD5 |
3a5fd8d69cc4c4103e21b16b76a4b1da
|
|
| BLAKE2b-256 |
1ce0e342f384e260e04a94710837e92944125e7b6ce68b132d9028d31118fa0c
|
File details
Details for the file knowl_apidocs-0.2.16.36-py3-none-any.whl.
File metadata
- Download URL: knowl_apidocs-0.2.16.36-py3-none-any.whl
- Upload date:
- Size: 8.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a9d95cc40f2dc9184bffef908f42eb26ec31003b73723e0acef4382d41fed42
|
|
| MD5 |
e5404b3757157d26c91c315ad5bd2ce6
|
|
| BLAKE2b-256 |
b16145920e473960e1f4d8b583747a3d3079a62d1fe1dadd347a00ebc681252e
|