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-reference
folder. - 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
Close
Hashes for knowl_apidocs-0.2.16.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 144967005d148d5cd78c33e27d780bfbfef072c1c158eb8f0815fb38cd776865 |
|
MD5 | 7683200e25367acfd81d1218c6640c19 |
|
BLAKE2b-256 | 425baa9747c36c7c0cf75c4fb354064fbb9b2aece6be622ec18c44044aa1b099 |