Skip to main content

No project description provided

Project description

Turbo Docs ๐Ÿš€

GitHub stars PyPI

Turbo Docs is a powerful Python package that automates the generation of documentation for your Python projects. It utilizes OpenAI's GPT models to create concise and informative documentation, making it easier for you and your users to understand your code.

๐Ÿ“š Table of Contents

๐ŸŽฏ Why Use Turbo Docs?

  • Save time: Turbo Docs automatically generates documentation for your Python functions, so you can focus on writing code.
  • Stay up-to-date: Turbo Docs can be easily integrated into your development workflow, ensuring your documentation is always current.
  • High-quality documentation: Turbo Docs leverages the power of OpenAI's GPT models to generate concise and informative documentation.
  • Customizable: You can choose between GPT-3.5 Turbo and GPT-4 models, and even provide your own templates for generating documentation.

๐ŸŒณ Repo Structure

turbo_docs/
โ”œโ”€โ”€ commands/
โ”‚   โ”œโ”€โ”€ docs.py
โ”‚   โ”œโ”€โ”€ readme.py
โ”‚   โ””โ”€โ”€ __init__.py
โ”œโ”€โ”€ utils/
โ”‚   โ”œโ”€โ”€ cli_options.py
โ”‚   โ”œโ”€โ”€ directory.py
โ”‚   โ”œโ”€โ”€ openai_api.py
โ”‚   โ””โ”€โ”€ __init__.py
โ”œโ”€โ”€ generate.py
โ”œโ”€โ”€ __init__.py
โ”œโ”€โ”€ setup.py
โ”œโ”€โ”€ requirements.txt
โ””โ”€โ”€ turbo_docs.toml

๐Ÿ“ฆ Installation

To install Turbo Docs, simply run:

pip install turbo_docs

๐Ÿ›  Usage

To generate documentation for your Python project, navigate to your project's root directory and run:

turbo_docs --docs

To generate a README.md file for your project, run:

turbo_docs --readme

For more options, run:

turbo_docs --help

๐Ÿค Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue to discuss any improvements or suggestions.

๐Ÿ“„ License

Turbo Docs is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

turbo_docs-1.0.2.tar.gz (6.8 kB view hashes)

Uploaded Source

Built Distribution

turbo_docs-1.0.2-py3-none-any.whl (13.2 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