Generate structured Markdown documentation from project directories
Project description
DocGen — Codebase Documentation Generator
DocGen scans your project directory and automatically generates comprehensive Markdown documentation. It creates:
- A visual directory tree of your codebase
- Code snippets with syntax highlighting
- File summaries and statistics
- A structured table of contents
You can target specific:
- Directories (e.g., only 'src/' and 'tests/')
- File types (e.g., only Python and JavaScript files)
- Code sections (using chunk size limits)
- Tree depth and visibility
Quick Start
# Install
pip install py-code-docgen
# Run interactive wizard
docgen -i
# Or generate docs directly
docgen . -o docs.md --include "py,js,cpp"
# Target specific folders and types
docgen . --folders "src,tests" --include "py" --show-progress
Features
- 🧙♂️ Interactive wizard for easy configuration
- 🌳 Project structure visualization with file filtering
- 📝 Code blocks with language detection
- 🎨 Customizable output (minimal/detailed)
- 📊 File statistics and line counts
- ⚡ Fast report mode for quick overviews
- 🎯 Selective documentation of directories and file types
Perfect for:
- Project documentation
- Codebase exploration
- Technical documentation
- Code review preparation
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
py_code_docgen-0.2.2.tar.gz
(16.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file py_code_docgen-0.2.2.tar.gz.
File metadata
- Download URL: py_code_docgen-0.2.2.tar.gz
- Upload date:
- Size: 16.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f601b3d189c9aad5174d3967dfe9a3aa61f8b14e69b1afb13c19ba8528fd4376
|
|
| MD5 |
523fa8f5d37ac6d1dbc35414189fa0eb
|
|
| BLAKE2b-256 |
713562ba2401ef5ddf59959b5d3529ea10e2fde894d82e25f680b6dc3b63c2c0
|
File details
Details for the file py_code_docgen-0.2.2-py3-none-any.whl.
File metadata
- Download URL: py_code_docgen-0.2.2-py3-none-any.whl
- Upload date:
- Size: 15.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
837e382b5e2948112902bcf371ac4c340bb52097e99a4ea0a2558246ebe7f395
|
|
| MD5 |
c7ae244e13b8651de3ab89da6d67bfa7
|
|
| BLAKE2b-256 |
ad4f9bc4d57e3ae70026b08e4b7f914469e6c6557c514f967394e88163cea7c5
|