Skip to main content

DocForge

AI-powered documentation generator for any GitHub repository or local project.

Quick Start

pip install docforge

# From GitHub URL
docforge generate https://github.com/user/repo

# From local path
docforge generate ./my-project

# With Ollama (local, free)
docforge generate ./my-project --model ollama/llama3 --api-base http://localhost:11434

What it generates

  • README.md — Comprehensive project overview
  • INSTALLATION.md — Setup and installation guide
  • ARCHITECTURE.md — System architecture with Mermaid diagrams
  • CHANGELOG.md — Formatted changelog from git history
  • api/*.md — Per-module API reference docs
  • mkdocs.yml — Optional MkDocs site config (--mkdocs)
  • .github/workflows/auto-docs.yml — Optional GitHub Action (--github-action)

Supported Languages

Python, JavaScript, TypeScript, Go, Rust, Java

Supported LLM Providers

  • OpenAI (default): --model gpt-4o
  • Anthropic Claude: --model claude-sonnet-4-6
  • Ollama (local): --model ollama/llama3 --api-base http://localhost:11434
  • Any provider supported by LiteLLM

License

MIT

Metadata

Release files for docforge-gen 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docforge-gen 0.1.0
File Size Uploaded
docforge_gen-0.1.0.tar.gz 22.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for docforge-gen 0.1.0
File Interpreter ABI Platform
docforge_gen-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 64.0 kB

Release files / docforge_gen-0.1.0.tar.gz

Download URL docforge_gen-0.1.0.tar.gz
Size 22.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d4a20961a5b70efefbfac2bd3ad65757c3ebf0c67cf47abb2cd26b0114f47d23
BLAKE2b-256 checksum
How to use checksums
cfdf0a433689cc87ef31e9535138e4ae5d4f810d0bc55713cf0f3cf9dcbd107f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / docforge_gen-0.1.0-py3-none-any.whl

Download URL docforge_gen-0.1.0-py3-none-any.whl
Size 41.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cee031be5eabe5b3260ba3a49172cab8cd37f940e96d0a8dcd3878e796ec15c1
BLAKE2b-256 checksum
How to use checksums
6f2468884e267569dfc55dc2aabd00121ad8d0946fa0179ab8f6fde2f12e7d65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page