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.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efcf38f39aa9cf90d038ecf4c839051ede00812b4dcb280af725df7c5c620866 |
|
MD5 | ab46b99efeebd862732291e25571643b |
|
BLAKE2b-256 | ed90ff0686202dc10b4664dc860a99bcfd997e2da3e350e44361df495640fde7 |