Skip to content

Files

Latest commit

 

History

History
45 lines (27 loc) · 1.46 KB

DOCUMENTATION.md

File metadata and controls

45 lines (27 loc) · 1.46 KB

AutoDoc Documentation

Introduction

AutoDoc is a tool that helps you automatically document your projects. It simplifies the process of capturing API documentation, generating file lists, and saving project information for easy reference.

Getting Started

  1. Clone the repository
  2. Get your own Groq API key for free here
  3. Run the "main.py" python file and Select your directory to automatically document your code.

API Reference

Currently, AutoDoc does not have a formal API defined.

Libraries Used

  1. Groq
  2. OS (system module)
  3. Path (pathlib)
  4. python-dotenv
  5. tkinter

Function Definitions

  • generate(): Generates documentation and saves it to the docs directory.
  • list_project_files(): Recursively iterates over the project directory and returns a list of files and directories.
  • save_file(filename, content): Saves the given content to the specified filename.

Additional Notes

  • The documentation is automatically generated and updated when you the generate() function is run.

Further Development

AutoDoc is still in its early stages of development. We encourage you to contribute ideas and suggestions to help us improve the tool.

Additional Files

The repository includes various utility functions and configurations that can be used with AutoDoc. Please refer to the source code for more details.


Documentation Generated by AutoDoc | 2024