Automated Documentation Generator

AI-powered tool that automatically generates and maintains technical documentation from Python codebases. Point it at any project folder and get complete, structured documentation in seconds.

Features

• AST-based code analysis — extracts functions, classes, arguments, return types
• AI-generated descriptions, usage examples, and architecture overviews
• Auto-versioning — tracks file hashes, only regenerates changed files
• Project overview with architecture summary
• Clean browsable documentation UI
• Supports any Python project — Flask, Django, scripts, libraries

Tech Stack

• Backend: Python, Flask, SQLAlchemy
• Analysis: Python AST module
• AI: Groq (Llama 3.3 70B)
• Frontend: Vanilla HTML/CSS/JS

Setup

1. Clone the repo
2. python -m venv venv then activate
3. pip install -r requirements.txt
4. Create .env:5. python app.py
5. Open http://localhost:5003

How it works

1. Enter the path to any Python project
2. Click Analyze to scan all .py files
3. Click Generate — AI reads each file's AST structure and writes documentation
4. Browse generated docs in the UI
5. Regenerate anytime — only changed files are re-documented

ScreenShots