Code Doc Generator

A VS Code extension that generates thorough documentation for Python files using AST parsing. It works fully offline.

Features

• AST Parsing: Uses Python's built-in ast module to understand code structure.
• Natural Language Generation: Converts code steps into readable English sentences.
• Context-Aware: Infers purpose and parameter details from code usage.
• Markdown Output: Generates a clean documentation.md file next to your source.

Requirements

• Python 3: Must be installed and available in your PATH as python or python3.

Usage

1. Open a .py file in VS Code.
2. Right-click in the editor and select Generate Documentation.
3. Alternatively, use the Command Palette (Ctrl+Shift+P) and search for Code Doc Generator: Generate Documentation.
4. A documentation.md file will be created in the same directory.

Installation for Development

1. Clone the repository.
2. Run npm install.
3. Open the project in VS Code.
4. Press F5 to launch the extension development host.
5. Open any file in the test-files folder to test.

License

MIT