237 functions | 54 classes | 39 files | CC̄ = 4.1

Auto-generated project documentation from source code analysis.

Author: Tom Sapletta
License: Apache-2.0(LICENSE)
Repository: https://github.com/wronai/code2docs

pip install code2docs

git clone https://github.com/wronai/code2docs
cd code2docs
pip install -e .

# Generate full documentation for your project
code2docs ./my-project

# Only regenerate README
code2docs ./my-project --readme-only

# Preview what would be generated (no file writes)
code2docs ./my-project --dry-run

# Check documentation health
code2docs check ./my-project

# Sync — regenerate only changed modules
code2docs sync ./my-project

from code2docs import generate_readme, generate_docs, Code2DocsConfig

# Quick: generate README
generate_readme("./my-project")

# Full: generate all documentation
config = Code2DocsConfig(project_name="mylib", verbose=True)
docs = generate_docs("./my-project", config=config)

When you run code2docs, the following files are produced:

<project>/
├── README.md                 # Main project README (auto-generated sections)
├── docs/
│   ├── api.md               # Consolidated API reference
│   ├── modules.md           # Module documentation with metrics
│   ├── architecture.md      # Architecture overview with diagrams
│   ├── dependency-graph.md  # Module dependency graphs
│   ├── coverage.md          # Docstring coverage report
│   ├── getting-started.md   # Getting started guide
│   ├── configuration.md    # Configuration reference
│   └── api-changelog.md    # API change tracking
├── examples/
│   ├── quickstart.py       # Basic usage examples
│   └── advanced_usage.py   # Advanced usage examples
├── CONTRIBUTING.md         # Contribution guidelines
└── mkdocs.yml             # MkDocs site configuration

Create code2docs.yaml in your project root (or run code2docs init):

project:
  name: my-project
  source: ./
  output: ./docs/

readme:
  sections:
    - overview
    - install
    - quickstart
    - api
    - structure
  badges:
    - version
    - python
    - coverage
  sync_markers: true

docs:
  api_reference: true
  module_docs: true
  architecture: true
  changelog: true

examples:
  auto_generate: true
  from_entry_points: true

sync:
  strategy: markers    # markers | full | git-diff
  watch: false
  ignore:
    - "tests/"
    - "__pycache__"

code2docs can update only specific sections of an existing README using HTML comment markers:

<!-- code2docs:start -->
# Project Title
... auto-generated content ...
<!-- code2docs:end -->

Content outside the markers is preserved when regenerating. Enable this with sync_markers: true in your configuration.

code2docs/
├── registry├── llm_helper├── code2docs/    ├── updater├── sync/    ├── watcher    ├── differ    ├── quickstart    ├── advanced_usage    ├── markdown    ├── badges├── base├── formatters/    ├── toc    ├── coverage_gen    ├── _source_links    ├── readme_gen    ├── depgraph_gen    ├── config_docs_gen    ├── getting_started_gen    ├── changelog_gen├── generators/    ├── code2llm_gen    ├── module_docs_gen    ├── api_reference_gen    ├── mkdocs_gen    ├── examples_gen    ├── _registry_adapters    ├── api_changelog_gen    ├── contributing_gen    ├── architecture_gen├── analyzers/├── cli├── config    ├── project_scanner    ├── dependency_scanner    ├── docstring_extractor    ├── endpoint_detector```

## API Overview

### Classes

- **`GeneratorRegistry`** — Registry of documentation generators.
- **`LLMHelper`** — Thin wrapper around litellm for documentation generation.
- **`Updater`** — Apply selective documentation updates based on detected changes.
- **`ChangeInfo`** — Describes a detected change.
- **`Differ`** — Detect changes between current source and previous state.
- **`MarkdownFormatter`** — Helper for constructing Markdown documents.
- **`GenerateContext`** — Shared context passed to all generators during a run.
- **`BaseGenerator`** — Abstract base for all documentation generators.
- **`CoverageGenerator`** — Generate docs/coverage.md — docstring coverage report.
- **`SourceLinker`** — Build source-code links (relative paths + optional GitHub/GitLab URLs).
- **`ReadmeGenerator`** — Generate README.md from AnalysisResult.
- **`DepGraphGenerator`** — Generate docs/dependency-graph.md with Mermaid diagrams.
- **`ConfigDocsGenerator`** — Generate docs/configuration.md from Code2DocsConfig dataclass.
- **`GettingStartedGenerator`** — Generate docs/getting-started.md from entry points and dependencies.
- **`ChangelogEntry`** — A single changelog entry.
- **`ChangelogGenerator`** — Generate CHANGELOG.md from git log and analysis diff.
- **`Code2LlmGenerator`** — Generate code2llm analysis files in project/ directory.
- **`ModuleDocsGenerator`** — Generate docs/modules.md — consolidated module documentation.
- **`ApiReferenceGenerator`** — Generate docs/api.md — consolidated API reference.
- **`MkDocsGenerator`** — Generate mkdocs.yml from the docs/ directory structure.
- **`ExamplesGenerator`** — Generate examples/ — usage examples from public API signatures.
- **`ReadmeGeneratorAdapter`** — —
- **`ApiReferenceAdapter`** — —
- **`ModuleDocsAdapter`** — —
- **`ArchitectureAdapter`** — —
- **`DepGraphAdapter`** — —
- **`CoverageAdapter`** — —
- **`ApiChangelogAdapter`** — —
- **`ExamplesAdapter`** — —
- **`MkDocsAdapter`** — —
- **`GettingStartedAdapter`** — —
- **`ConfigDocsAdapter`** — —
- **`ContributingAdapter`** — —
- **`Code2LlmAdapter`** — Adapter for code2llm analysis generation.
- **`ApiChange`** — A single API change between two analysis snapshots.
- **`ApiChangelogGenerator`** — Generate API changelog by diffing current analysis with a saved snapshot.
- **`ContributingGenerator`** — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
- **`ArchitectureGenerator`** — Generate docs/architecture.md — architecture overview with diagrams.
- **`DefaultGroup`** — Click Group that routes unknown subcommands to 'generate'.
- **`ReadmeConfig`** — Configuration for README generation.
- **`DocsConfig`** — Configuration for docs/ generation.
- **`ExamplesConfig`** — Configuration for examples/ generation.
- **`SyncConfig`** — Configuration for synchronization.
- **`Code2LlmConfig`** — Configuration for code2llm analysis generation.
- **`LLMConfig`** — Configuration for optional LLM-assisted documentation generation.
- **`Code2DocsConfig`** — Main configuration for code2docs.
- **`ProjectScanner`** — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
- **`DependencyInfo`** — Information about a project dependency.
- **`ProjectDependencies`** — All detected project dependencies.
- **`DependencyScanner`** — Scan and parse project dependency files.
- **`DocstringInfo`** — Parsed docstring with sections.
- **`DocstringExtractor`** — Extract and parse docstrings from AnalysisResult.
- **`Endpoint`** — Represents a detected web endpoint.
- **`EndpointDetector`** — Detects web endpoints from decorator patterns in source code.

### Functions

- `start_watcher(project_path, config)` — Start watching project for file changes and auto-resync docs.
- `generate_badges(project_name, badge_types, stats, deps)` — Generate shields.io badge Markdown strings.
- `generate_toc(markdown_content, max_depth)` — Generate a table of contents from Markdown headings.
- `extract_headings(content, max_depth)` — Extract headings from Markdown content.
- `generate_readme(project_path, output, sections, sync_markers)` — Convenience function to generate a README.
- `generate_docs(project_path, config)` — High-level function to generate all documentation.
- `parse_gitignore(project_path)` — Parse .gitignore file and return list of patterns to exclude.
- `generate_code2llm_analysis(project_path, config)` — Convenience function to generate code2llm analysis.
- `main()` — code2docs — Auto-generate project documentation from source code.
- `generate(project_path, config_path, readme_only, sections)` — Generate documentation (default command).
- `sync(project_path, config_path, verbose, dry_run)` — Synchronize documentation with source code changes.
- `watch(project_path, config_path, verbose)` — Watch for file changes and auto-regenerate docs.
- `init(project_path, output)` — Initialize code2docs.yaml configuration file.
- `check(project_path, config_path, target)` — Health check — verify documentation completeness.
- `diff(project_path, config_path)` — Preview what would change without writing anything.
- `analyze_and_document(project_path, config)` — Convenience function: analyze a project in one call.


## Project Structure

📄 `__main__`
📦 `analyzers`
📄 `analyzers.dependency_scanner` (6 functions, 3 classes)
📄 `analyzers.docstring_extractor` (10 functions, 2 classes)
📄 `analyzers.endpoint_detector` (3 functions, 2 classes)
📄 `analyzers.project_scanner` (4 functions, 1 classes)
📄 `base` (3 functions, 2 classes)
📄 `cli` (14 functions, 1 classes)
📦 `code2docs` (1 functions)
📄 `config` (5 functions, 7 classes)
📄 `examples.advanced_usage`
📄 `examples.quickstart`
📦 `formatters`
📄 `formatters.badges` (2 functions)
📄 `formatters.markdown` (13 functions, 1 classes)
📄 `formatters.toc` (3 functions)
📦 `generators` (1 functions)
📄 `generators._registry_adapters` (26 functions, 13 classes)
📄 `generators._source_links` (6 functions, 1 classes)
📄 `generators.api_changelog_gen` (9 functions, 2 classes)
📄 `generators.api_reference_gen` (7 functions, 1 classes)
📄 `generators.architecture_gen` (10 functions, 1 classes)
📄 `generators.changelog_gen` (6 functions, 2 classes)
📄 `generators.code2llm_gen` (6 functions, 1 classes)
📄 `generators.config_docs_gen` (4 functions, 1 classes)
📄 `generators.contributing_gen` (8 functions, 1 classes)
📄 `generators.coverage_gen` (7 functions, 1 classes)
📄 `generators.depgraph_gen` (9 functions, 1 classes)
📄 `generators.examples_gen` (14 functions, 1 classes)
📄 `generators.getting_started_gen` (8 functions, 1 classes)
📄 `generators.mkdocs_gen` (4 functions, 1 classes)
📄 `generators.module_docs_gen` (9 functions, 1 classes)
📄 `generators.readme_gen` (18 functions, 1 classes)
📄 `llm_helper` (7 functions, 1 classes)
📄 `registry` (4 functions, 1 classes)
📦 `sync`
📄 `sync.differ` (7 functions, 2 classes)
📄 `sync.updater` (2 functions, 1 classes)
📄 `sync.watcher` (1 functions)

## Requirements



## Contributing

**Contributors:**
- Tom Softreck <[email protected]>
- Tom Sapletta <[email protected]>

We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.

### Development Setup

```bash
# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage ├── markdown ├── badges ├── toc├── formatters/├── base ├── readme_gen ├── coverage_gen ├── _source_links ├── depgraph_gen ├── getting_started_gen ├── config_docs_gen ├── changelog_gen├── generators/ ├── code2llm_gen ├── module_docs_gen ├── api_reference_gen ├── mkdocs_gen ├── _registry_adapters ├── examples_gen ├── api_changelog_gen ├── contributing_gen ├── architecture_gen├── analyzers/├── cli├── config ├── project_scanner ├── docstring_extractor ├── dependency_scanner ├── endpoint_detector```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• MarkdownFormatter — Helper for constructing Markdown documents.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• Code2LlmGenerator — Generate code2llm analysis files in project/ directory.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• Code2LlmAdapter — Adapter for code2llm analysis generation.
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• Code2LlmConfig — Configuration for code2llm analysis generation.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• parse_gitignore(project_path) — Parse .gitignore file and return list of patterns to exclude.
• generate_code2llm_analysis(project_path, config) — Convenience function to generate code2llm analysis.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 7 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (26 functions, 13 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.code2llm_gen (6 functions, 1 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage ├── markdown ├── badges ├── toc├── formatters/├── base ├── readme_gen ├── _source_links ├── coverage_gen ├── depgraph_gen ├── getting_started_gen ├── config_docs_gen├── generators/ ├── changelog_gen ├── code2llm_gen ├── module_docs_gen ├── api_reference_gen ├── mkdocs_gen ├── examples_gen ├── _registry_adapters ├── api_changelog_gen ├── contributing_gen ├── architecture_gen├── analyzers/├── cli├── config ├── project_scanner ├── dependency_scanner ├── docstring_extractor ├── endpoint_detector```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• MarkdownFormatter — Helper for constructing Markdown documents.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• Code2LlmGenerator — Generate code2llm analysis files in project/ directory.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• Code2LlmAdapter — Adapter for code2llm analysis generation.
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• Code2LlmConfig — Configuration for code2llm analysis generation.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• parse_gitignore(project_path) — Parse .gitignore file and return list of patterns to exclude.
• generate_code2llm_analysis(project_path, config) — Convenience function to generate code2llm analysis.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 7 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (26 functions, 13 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.code2llm_gen (6 functions, 1 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage ├── markdown ├── badges ├── toc├── formatters/ ├── readme_gen ├── coverage_gen ├── _source_links ├── depgraph_gen ├── getting_started_gen ├── config_docs_gen ├── changelog_gen├── generators/ ├── code2llm_gen├── base ├── module_docs_gen ├── api_reference_gen ├── mkdocs_gen├── cli ├── examples_gen ├── _registry_adapters ├── contributing_gen ├── architecture_gen├── analyzers/ ├── api_changelog_gen├── config ├── project_scanner ├── dependency_scanner ├── docstring_extractor ├── endpoint_detector```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• MarkdownFormatter — Helper for constructing Markdown documents.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• Code2LlmGenerator — Generate code2llm analysis files in project/ directory.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• Code2LlmAdapter — Adapter for code2llm analysis generation.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• Code2LlmConfig — Configuration for code2llm analysis generation.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• parse_gitignore(project_path) — Parse .gitignore file and return list of patterns to exclude.
• generate_code2llm_analysis(project_path, config) — Convenience function to generate code2llm analysis.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 7 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (26 functions, 13 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.code2llm_gen (6 functions, 1 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage ├── markdown ├── badges ├── toc├── formatters/├── base ├── readme_gen ├── _source_links ├── coverage_gen ├── depgraph_gen ├── getting_started_gen ├── config_docs_gen├── generators/ ├── changelog_gen ├── code2llm_gen ├── module_docs_gen ├── api_reference_gen ├── mkdocs_gen ├── examples_gen ├── _registry_adapters ├── api_changelog_gen ├── contributing_gen ├── architecture_gen├── analyzers/├── cli├── config ├── project_scanner ├── dependency_scanner ├── docstring_extractor ├── endpoint_detector```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• MarkdownFormatter — Helper for constructing Markdown documents.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• Code2LlmGenerator — Generate code2llm analysis files in project/ directory.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• Code2LlmAdapter — Adapter for code2llm analysis generation.
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• Code2LlmConfig — Configuration for code2llm analysis generation.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• parse_gitignore(project_path) — Parse .gitignore file and return list of patterns to exclude.
• generate_code2llm_analysis(project_path, config) — Convenience function to generate code2llm analysis.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 7 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (26 functions, 13 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.code2llm_gen (6 functions, 1 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage ├── markdown ├── badges ├── toc├── formatters/├── base ├── readme_gen ├── coverage_gen ├── _source_links ├── depgraph_gen ├── getting_started_gen ├── config_docs_gen├── generators/ ├── changelog_gen ├── api_reference_gen ├── module_docs_gen ├── mkdocs_gen ├── _registry_adapters ├── examples_gen ├── api_changelog_gen ├── contributing_gen ├── architecture_gen├── cli├── analyzers/├── config ├── project_scanner ├── dependency_scanner ├── endpoint_detector ├── docstring_extractor```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• MarkdownFormatter — Helper for constructing Markdown documents.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 6 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (24 functions, 12 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage├── base ├── markdown ├── badges ├── toc├── formatters/ ├── coverage_gen ├── _source_links ├── depgraph_gen ├── readme_gen ├── config_docs_gen ├── getting_started_gen├── generators/ ├── changelog_gen ├── module_docs_gen ├── api_reference_gen ├── mkdocs_gen ├── examples_gen ├── _registry_adapters ├── api_changelog_gen ├── architecture_gen├── cli ├── contributing_gen├── analyzers/├── config ├── project_scanner ├── docstring_extractor ├── dependency_scanner ├── endpoint_detector```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• MarkdownFormatter — Helper for constructing Markdown documents.
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 6 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (24 functions, 12 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples

Content outside the markers is preserved when regenerating. Enable this with `sync_markers: true` in your configuration.

## Architecture

code2docs/ ├── registry├── llm_helper├── code2docs/ ├── updater├── sync/ ├── watcher ├── differ ├── quickstart ├── advanced_usage ├── markdown ├── badges ├── toc├── formatters/├── base ├── readme_gen ├── _source_links ├── coverage_gen ├── getting_started_gen ├── depgraph_gen ├── config_docs_gen├── generators/ ├── changelog_gen ├── api_reference_gen ├── module_docs_gen ├── mkdocs_gen ├── _registry_adapters ├── examples_gen ├── api_changelog_gen ├── architecture_gen ├── contributing_gen├── analyzers/├── cli├── config ├── project_scanner ├── dependency_scanner ├── docstring_extractor ├── endpoint_detector```

• GeneratorRegistry — Registry of documentation generators.
• LLMHelper — Thin wrapper around litellm for documentation generation.
• Updater — Apply selective documentation updates based on detected changes.
• ChangeInfo — Describes a detected change.
• Differ — Detect changes between current source and previous state.
• MarkdownFormatter — Helper for constructing Markdown documents.
• GenerateContext — Shared context passed to all generators during a run.
• BaseGenerator — Abstract base for all documentation generators.
• ReadmeGenerator — Generate README.md from AnalysisResult.
• SourceLinker — Build source-code links (relative paths + optional GitHub/GitLab URLs).
• CoverageGenerator — Generate docs/coverage.md — docstring coverage report.
• GettingStartedGenerator — Generate docs/getting-started.md from entry points and dependencies.
• DepGraphGenerator — Generate docs/dependency-graph.md with Mermaid diagrams.
• ConfigDocsGenerator — Generate docs/configuration.md from Code2DocsConfig dataclass.
• ChangelogEntry — A single changelog entry.
• ChangelogGenerator — Generate CHANGELOG.md from git log and analysis diff.
• ApiReferenceGenerator — Generate docs/api.md — consolidated API reference.
• ModuleDocsGenerator — Generate docs/modules.md — consolidated module documentation.
• MkDocsGenerator — Generate mkdocs.yml from the docs/ directory structure.
• ReadmeGeneratorAdapter — —
• ApiReferenceAdapter — —
• ModuleDocsAdapter — —
• ArchitectureAdapter — —
• DepGraphAdapter — —
• CoverageAdapter — —
• ApiChangelogAdapter — —
• ExamplesAdapter — —
• MkDocsAdapter — —
• GettingStartedAdapter — —
• ConfigDocsAdapter — —
• ContributingAdapter — —
• ExamplesGenerator — Generate examples/ — usage examples from public API signatures.
• ApiChange — A single API change between two analysis snapshots.
• ApiChangelogGenerator — Generate API changelog by diffing current analysis with a saved snapshot.
• ArchitectureGenerator — Generate docs/architecture.md — architecture overview with diagrams.
• ContributingGenerator — Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
• DefaultGroup — Click Group that routes unknown subcommands to 'generate'.
• ReadmeConfig — Configuration for README generation.
• DocsConfig — Configuration for docs/ generation.
• ExamplesConfig — Configuration for examples/ generation.
• SyncConfig — Configuration for synchronization.
• LLMConfig — Configuration for optional LLM-assisted documentation generation.
• Code2DocsConfig — Main configuration for code2docs.
• ProjectScanner — Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
• DependencyInfo — Information about a project dependency.
• ProjectDependencies — All detected project dependencies.
• DependencyScanner — Scan and parse project dependency files.
• DocstringInfo — Parsed docstring with sections.
• DocstringExtractor — Extract and parse docstrings from AnalysisResult.
• Endpoint — Represents a detected web endpoint.
• EndpointDetector — Detects web endpoints from decorator patterns in source code.

• start_watcher(project_path, config) — Start watching project for file changes and auto-resync docs.
• generate_badges(project_name, badge_types, stats, deps) — Generate shields.io badge Markdown strings.
• generate_toc(markdown_content, max_depth) — Generate a table of contents from Markdown headings.
• extract_headings(content, max_depth) — Extract headings from Markdown content.
• generate_readme(project_path, output, sections, sync_markers) — Convenience function to generate a README.
• generate_docs(project_path, config) — High-level function to generate all documentation.
• main() — code2docs — Auto-generate project documentation from source code.
• generate(project_path, config_path, readme_only, sections) — Generate documentation (default command).
• sync(project_path, config_path, verbose, dry_run) — Synchronize documentation with source code changes.
• watch(project_path, config_path, verbose) — Watch for file changes and auto-regenerate docs.
• init(project_path, output) — Initialize code2docs.yaml configuration file.
• check(project_path, config_path, target) — Health check — verify documentation completeness.
• diff(project_path, config_path) — Preview what would change without writing anything.
• analyze_and_document(project_path, config) — Convenience function: analyze a project in one call.

📄 __main__ 📦 analyzers 📄 analyzers.dependency_scanner (6 functions, 3 classes) 📄 analyzers.docstring_extractor (10 functions, 2 classes) 📄 analyzers.endpoint_detector (3 functions, 2 classes) 📄 analyzers.project_scanner (4 functions, 1 classes) 📄 base (3 functions, 2 classes) 📄 cli (14 functions, 1 classes) 📦 code2docs (1 functions) 📄 config (5 functions, 6 classes) 📄 examples.advanced_usage 📄 examples.quickstart 📦 formatters 📄 formatters.badges (2 functions) 📄 formatters.markdown (13 functions, 1 classes) 📄 formatters.toc (3 functions) 📦 generators (1 functions) 📄 generators._registry_adapters (24 functions, 12 classes) 📄 generators._source_links (6 functions, 1 classes) 📄 generators.api_changelog_gen (9 functions, 2 classes) 📄 generators.api_reference_gen (7 functions, 1 classes) 📄 generators.architecture_gen (10 functions, 1 classes) 📄 generators.changelog_gen (6 functions, 2 classes) 📄 generators.config_docs_gen (4 functions, 1 classes) 📄 generators.contributing_gen (8 functions, 1 classes) 📄 generators.coverage_gen (7 functions, 1 classes) 📄 generators.depgraph_gen (9 functions, 1 classes) 📄 generators.examples_gen (14 functions, 1 classes) 📄 generators.getting_started_gen (8 functions, 1 classes) 📄 generators.mkdocs_gen (4 functions, 1 classes) 📄 generators.module_docs_gen (9 functions, 1 classes) 📄 generators.readme_gen (18 functions, 1 classes) 📄 llm_helper (7 functions, 1 classes) 📄 registry (4 functions, 1 classes) 📦 sync 📄 sync.differ (7 functions, 2 classes) 📄 sync.updater (2 functions, 1 classes) 📄 sync.watcher (1 functions)

Contributors:

• Tom Softreck [email protected]
• Tom Sapletta [email protected]

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

# Clone the repository
git clone https://github.com/wronai/code2docs
cd code2docs

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

• 📖 Full Documentation — API reference, module docs, architecture
• 🚀 Getting Started — Quick start guide
• 📚 API Reference — Complete API documentation
• 🔧 Configuration — Configuration options
• 💡 Examples — Usage examples and code samples