Skip to main content

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 the api-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

  1. Install knowl-apidocs via pip:
pip install knowl-apidocs
  1. 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

knowl_apidocs-0.2.16.28.tar.gz (6.6 kB view hashes)

Uploaded Source

Built Distribution

knowl_apidocs-0.2.16.28-py3-none-any.whl (8.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page