Quick Start

Install dependencies:

uv sync

Generate documentation:

uv run docgen ./examples/sample_project --output ./generated-docs

Preview without writing:

uv run docgen ./examples/sample_project --dry-run

Ask a question:

uv run docgen ask ./examples/sample_project "What does the package expose?"

Inspect a repository without generating files:

uv run docgen inspect ./examples/sample_project

Print diagrams:

uv run docgen diagram ./examples/sample_project

Use a hosted provider:

uv sync --extra openai
uv run docgen ./examples/sample_project --llm openai --model gpt-5.5

Build the documentation site:

uv run mkdocs build --strict