semcod

← all projects

code2docs

Auto-generate and sync project documentation from source code analysis

Python updated 1h ago View on GitHub β†’ Homepage

AI Cost Tracking

PyPI Version Python License
AI Cost Human Time Model

  • πŸ€– LLM usage: $30.6579 (87 commits)
  • πŸ‘€ Human dev: ~$3690 (36.9h @ $100/h, 30min dedup)

Generated on 2026-07-29 using openrouter/qwen/qwen3-coder-next

version python docs

Auto-generate and sync project documentation from source code analysis.

code2docs uses code2llm's AnalysisResult to produce human-readable documentation: README.md, API references, module docs, usage examples, and architecture diagrams.

code2llm  β†’  AnalysisResult  β†’  .toon / .mmd / context.md   (for LLM)
code2docs β†’  AnalysisResult  β†’  README.md / docs/ / examples/  (for humans)

Installation

pip install code2docs

Or from source:

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

Optional extras

pip install code2docs[watch]    # file watcher (watchdog)
pip install code2docs[mkdocs]   # MkDocs integration
pip install code2docs[dev]      # development tools

Generate full documentation for a project

code2docs ./my-project

Generate only README

code2docs ./my-project --readme-only

Sync (regenerate only changed modules)

code2docs sync ./my-project

Watch mode (auto-resync on file changes)

code2docs watch ./my-project

Initialize config file

code2docs init ./my-project

Dry-run (show what would be generated)

code2docs ./my-project --dry-run


### Python API

```python
from code2docs import generate_readme, generate_docs, Code2DocsConfig

# Generate README
generate_readme("./my-project", output="README.md")

# Generate full docs with custom config
config = Code2DocsConfig(project_name="mylib", verbose=True)
docs = generate_docs("./my-project", config=config)

Generated Output

<project>/
β”œβ”€β”€ README.md                      # Main README (auto-generated sections)
β”œβ”€β”€ docs/
β”‚   β”œβ”€β”€ index.md                   # Documentation index
β”‚   β”œβ”€β”€ architecture.md            # Architecture + Mermaid diagrams
β”‚   β”œβ”€β”€ api/
β”‚   β”‚   β”œβ”€β”€ index.md               # API overview
β”‚   β”‚   β”œβ”€β”€ module_analyzer.md     # Per-module API reference
β”‚   β”‚   └── ...
β”‚   └── modules/
β”‚       β”œβ”€β”€ analyzer.md            # Detailed module documentation
β”‚       └── ...
β”œβ”€β”€ examples/
β”‚   β”œβ”€β”€ basic_usage.py             # Auto-generated usage example
β”‚   β”œβ”€β”€ class_examples.py          # Class usage examples
β”‚   └── ...
└── code2docs.yaml                 # Generator configuration

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
    - endpoints
  badges:
    - version
    - python
    - coverage
    - complexity
  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__"

Sync Markers

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

<!-- code2docs:start --># code2docs

![version](https://img.shields.io/badge/version-3.0.34-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![coverage](https://img.shields.io/badge/coverage-unknown-lightgrey) ![functions](https://img.shields.io/badge/functions-276-green)
> **276** functions | **57** classes | **51** files | CCΜ„ = 3.8

> Auto-generated project documentation from source code analysis.

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

### From PyPI

```bash
pip install code2docs

From Source

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

Optional Extras

pip install code2docs[llm]    # LLM integration (litellm)
pip install code2docs[git]    # Git integration (GitPython)
pip install code2docs[watch]    # file watcher (watchdog)
pip install code2docs[mkdocs]    # MkDocs integration
pip install code2docs[dev]    # development tools
pip install code2docs[all]    # all optional features

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


### Python API

```python
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)

Generated Output

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

Sync Markers

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.

Architecture

code2docs/
    β”œβ”€β”€ registry    β”œβ”€β”€ llm_helperβ”œβ”€β”€ code2docs/    β”œβ”€β”€ __main__    β”œβ”€β”€ 04_sync_and_watch    β”œβ”€β”€ 05_custom_generators    β”œβ”€β”€ quickstart    β”œβ”€β”€ 06_formatters    β”œβ”€β”€ advanced_usage    β”œβ”€β”€ 03_programmatic_api    β”œβ”€β”€ entry_points    β”œβ”€β”€ 07_web_frameworks    β”œβ”€β”€ class_examples    β”œβ”€β”€ basic_usage    β”œβ”€β”€ 01_cli_usage    β”œβ”€β”€ 02_configuration        β”œβ”€β”€ updater    β”œβ”€β”€ sync/        β”œβ”€β”€ watcher    β”œβ”€β”€ base        β”œβ”€β”€ quickstart        β”œβ”€β”€ advanced_usage        β”œβ”€β”€ markdown        β”œβ”€β”€ badges        β”œβ”€β”€ toc    β”œβ”€β”€ formatters/        β”œβ”€β”€ differ        β”œβ”€β”€ coverage_gen        β”œβ”€β”€ _source_links        β”œβ”€β”€ depgraph_gen        β”œβ”€β”€ getting_started_gen        β”œβ”€β”€ config_docs_gen        β”œβ”€β”€ changelog_gen    β”œβ”€β”€ generators/        β”œβ”€β”€ code2llm_gen        β”œβ”€β”€ module_docs_gen        β”œβ”€β”€ api_reference_gen        β”œβ”€β”€ examples_gen        β”œβ”€β”€ mkdocs_gen    β”œβ”€β”€ config        β”œβ”€β”€ api_changelog_gen        β”œβ”€β”€ _registry_adapters        β”œβ”€β”€ readme_gen        β”œβ”€β”€ contributing_gen    β”œβ”€β”€ analyzers/        β”œβ”€β”€ dependency_scanner        β”œβ”€β”€ endpoint_detector        β”œβ”€β”€ architecture_gen        β”œβ”€β”€ project_scanner        β”œβ”€β”€ docstring_extractor    β”œβ”€β”€ cli```

### Classes

- **`GeneratorRegistry`** β€” Registry of documentation generators.
- **`LLMHelper`** β€” Thin wrapper around litellm for documentation generation.
- **`MetricsReportGenerator`** β€” Generate a metrics report from code analysis.
- **`APIChangelogGenerator`** β€” Generate changelog based on API changes.
- **`CustomGenerator`** β€” Example of extending the base generator class.
- **`Updater`** β€” Apply selective documentation updates based on detected changes.
- **`GenerateContext`** β€” Shared context passed to all generators during a run.
- **`BaseGenerator`** β€” Abstract base for all documentation generators.
- **`MarkdownFormatter`** β€” Helper for constructing Markdown documents.
- **`ChangeInfo`** β€” Describes a detected change.
- **`Differ`** β€” Detect changes between current source and previous state.
- **`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.
- **`ExamplesGenerator`** β€” Generate examples/ β€” usage examples from public API signatures.
- **`MkDocsGenerator`** β€” Generate mkdocs.yml from the docs/ directory structure.
- **`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.
- **`ApiChange`** β€” A single API change between two analysis snapshots.
- **`ApiChangelogGenerator`** β€” Generate API changelog by diffing current analysis with a saved snapshot.
- **`ReadmeGeneratorAdapter`** β€” β€”
- **`ApiReferenceAdapter`** β€” β€”
- **`ModuleDocsAdapter`** β€” β€”
- **`ArchitectureAdapter`** β€” β€”
- **`DepGraphAdapter`** β€” β€”
- **`CoverageAdapter`** β€” β€”
- **`ApiChangelogAdapter`** β€” β€”
- **`ExamplesAdapter`** β€” β€”
- **`MkDocsAdapter`** β€” β€”
- **`GettingStartedAdapter`** β€” β€”
- **`ConfigDocsAdapter`** β€” β€”
- **`ContributingAdapter`** β€” β€”
- **`Code2LlmAdapter`** β€” Adapter for code2llm analysis generation.
- **`ReadmeGenerator`** β€” Generate README.md from AnalysisResult.
- **`ContributingGenerator`** β€” Generate CONTRIBUTING.md by detecting dev tools from pyproject.toml.
- **`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.
- **`ArchitectureGenerator`** β€” Generate docs/architecture.md β€” architecture overview with diagrams.
- **`ProjectScanner`** β€” Wraps code2llm's ProjectAnalyzer with code2docs-specific defaults.
- **`DocstringInfo`** β€” Parsed docstring with sections.
- **`DocstringExtractor`** β€” Extract and parse docstrings from AnalysisResult.
- **`DefaultGroup`** β€” Click Group that routes unknown subcommands to 'generate'.

### Functions

- `detect_changes_example(project_path)` β€” Detect what files have changed since last documentation generation.
- `update_docs_incrementally(project_path)` β€” Update only the parts of docs that need changing.
- `force_full_regeneration(project_path)` β€” Force full regeneration of all documentation.
- `watch_and_auto_regenerate(project_path, interval)` β€” Watch for file changes and auto-regenerate documentation.
- `custom_watcher_with_hooks(project_path)` β€” Set up a custom watcher with pre/post generation hooks.
- `sync_with_git_changes(project_path)` β€” Only regenerate docs for files changed in git.
- `generate_custom_report(project_path)` β€” Generate a custom metrics report.
- `markdown_formatting_examples()` β€” Demonstrate markdown formatting utilities.
- `generate_complex_document()` β€” Generate a complex markdown document using the formatter.
- `badge_examples()` β€” Generate various badge examples.
- `toc_examples()` β€” Demonstrate table of contents generation.
- `build_custom_readme()` β€” Build a custom README using formatters.
- `generate_readme_simple(project_path)` β€” Generate README.md content from a project.
- `generate_full_documentation(project_path)` β€” Generate complete documentation for a project.
- `custom_documentation_pipeline(project_path)` β€” Create a custom documentation pipeline.
- `inspect_project_structure(project_path)` β€” Inspect project structure from analysis.
- `generate_docs_if_needed(project_path, force)` β€” Only generate docs if code has changed.
- `detect_flask_endpoints(project_path)` β€” Detect Flask endpoints in a project.
- `detect_fastapi_endpoints(project_path)` β€” Detect FastAPI endpoints in a project.
- `generate_api_docs_from_endpoints(project_path, output_dir)` β€” Generate API documentation from detected endpoints.
- `create_example_web_apps(target_dir)` β€” Create example Flask and FastAPI apps for testing.
- `document_web_project(project_path)` β€” Complete workflow: detect endpoints and generate docs.
- `run_cli_basic(project_path)` β€” Run code2docs CLI programmatically.
- `run_cli_with_config(project_path, config_path)` β€” Run with custom configuration.
- `create_basic_config()` β€” Create a basic configuration.
- `create_advanced_config()` β€” Create advanced configuration with all options.
- `save_yaml_config_example(path)` β€” Save example YAML config to file.
- `load_config_from_yaml(path)` β€” Load configuration from YAML file.
- `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_docs(project_path, config)` β€” High-level function to generate all documentation.
- `generate_code2llm_analysis(project_path, config)` β€” Convenience function to generate code2llm analysis.
- `generate_readme(project_path, output, sections, sync_markers)` β€” Convenience function to generate a README.
- `analyze_and_document(project_path, config)` β€” Convenience function: analyze a project in one call.
- `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.


## Project Structure

πŸ“¦ `code2docs` (1 functions)
πŸ“„ `code2docs.__main__`
πŸ“¦ `code2docs.analyzers`
πŸ“„ `code2docs.analyzers.dependency_scanner` (6 functions, 3 classes)
πŸ“„ `code2docs.analyzers.docstring_extractor` (10 functions, 2 classes)
πŸ“„ `code2docs.analyzers.endpoint_detector` (3 functions, 2 classes)
πŸ“„ `code2docs.analyzers.project_scanner` (4 functions, 1 classes)
πŸ“„ `code2docs.base` (3 functions, 2 classes)
πŸ“„ `code2docs.cli` (14 functions, 1 classes)
πŸ“„ `code2docs.config` (5 functions, 7 classes)
πŸ“„ `code2docs.examples.advanced_usage`
πŸ“„ `code2docs.examples.quickstart`
πŸ“¦ `code2docs.formatters`
πŸ“„ `code2docs.formatters.badges` (2 functions)
πŸ“„ `code2docs.formatters.markdown` (13 functions, 1 classes)
πŸ“„ `code2docs.formatters.toc` (3 functions)
πŸ“¦ `code2docs.generators` (1 functions)
πŸ“„ `code2docs.generators._registry_adapters` (26 functions, 13 classes)
πŸ“„ `code2docs.generators._source_links` (6 functions, 1 classes)
πŸ“„ `code2docs.generators.api_changelog_gen` (9 functions, 2 classes)
πŸ“„ `code2docs.generators.api_reference_gen` (7 functions, 1 classes)
πŸ“„ `code2docs.generators.architecture_gen` (10 functions, 1 classes)
πŸ“„ `code2docs.generators.changelog_gen` (6 functions, 2 classes)
πŸ“„ `code2docs.generators.code2llm_gen` (5 functions, 1 classes)
πŸ“„ `code2docs.generators.config_docs_gen` (4 functions, 1 classes)
πŸ“„ `code2docs.generators.contributing_gen` (8 functions, 1 classes)
πŸ“„ `code2docs.generators.coverage_gen` (7 functions, 1 classes)
πŸ“„ `code2docs.generators.depgraph_gen` (9 functions, 1 classes)
πŸ“„ `code2docs.generators.examples_gen` (14 functions, 1 classes)
πŸ“„ `code2docs.generators.getting_started_gen` (8 functions, 1 classes)
πŸ“„ `code2docs.generators.mkdocs_gen` (4 functions, 1 classes)
πŸ“„ `code2docs.generators.module_docs_gen` (9 functions, 1 classes)
πŸ“„ `code2docs.generators.readme_gen` (18 functions, 1 classes)
πŸ“„ `code2docs.llm_helper` (7 functions, 1 classes)
πŸ“„ `code2docs.registry` (4 functions, 1 classes)
πŸ“¦ `code2docs.sync`
πŸ“„ `code2docs.sync.differ` (7 functions, 2 classes)
πŸ“„ `code2docs.sync.updater` (2 functions, 1 classes)
πŸ“„ `code2docs.sync.watcher` (1 functions)
πŸ“„ `examples.01_cli_usage` (2 functions)
πŸ“„ `examples.02_configuration` (4 functions)
πŸ“„ `examples.03_programmatic_api` (5 functions)
πŸ“„ `examples.04_sync_and_watch` (6 functions)
πŸ“„ `examples.05_custom_generators` (13 functions, 3 classes)
πŸ“„ `examples.06_formatters` (5 functions)
πŸ“„ `examples.07_web_frameworks` (5 functions)
πŸ“„ `examples.advanced_usage`
πŸ“„ `examples.basic_usage`
πŸ“„ `examples.class_examples`
πŸ“„ `examples.entry_points`
πŸ“„ `examples.quickstart`

## Requirements

- Python >= >=3.9
- code2llm >=0.5.0- jinja2 >=3.1- click >=8.0- pyyaml >=6.0- rich >=13.0

## Contributing

**Contributors:**
- Tom Softreck <tom@sapletta.com>
- Tom Sapletta <tom-sapletta-com@users.noreply.github.com>

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

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

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

## Documentation

- πŸ“– [Full Documentation](https://github.com/wronai/code2docs/tree/main/docs) β€” API reference, module docs, architecture
- πŸš€ [Getting Started](https://github.com/wronai/code2docs/blob/main/docs/getting-started.md) β€” Quick start guide
- πŸ“š [API Reference](https://github.com/wronai/code2docs/blob/main/docs/api.md) β€” Complete API documentation
- πŸ”§ [Configuration](https://github.com/wronai/code2docs/blob/main/docs/configuration.md) β€” Configuration options
- πŸ’‘ [Examples](./examples) β€” Usage examples and code samples

### Generated Files

| Output | Description | Link |
|--------|-------------|------|
| `README.md` | Project overview (this file) | β€” |
| `docs/api.md` | Consolidated API reference | [View](./docs/api.md) |
| `docs/modules.md` | Module reference with metrics | [View](./docs/modules.md) |
| `docs/architecture.md` | Architecture with diagrams | [View](./docs/architecture.md) |
| `docs/dependency-graph.md` | Dependency graphs | [View](./docs/dependency-graph.md) |
| `docs/coverage.md` | Docstring coverage report | [View](./docs/coverage.md) |
| `docs/getting-started.md` | Getting started guide | [View](./docs/getting-started.md) |
| `docs/configuration.md` | Configuration reference | [View](./docs/configuration.md) |
| `docs/api-changelog.md` | API change tracking | [View](./docs/api-changelog.md) |
| `CONTRIBUTING.md` | Contribution guidelines | [View](./CONTRIBUTING.md) |
| `examples/` | Usage examples | [Browse](./examples) |
| `mkdocs.yml` | MkDocs configuration | β€” |

<!-- code2docs:end -->

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

Architecture

code2docs/
    β”œβ”€β”€ registry    β”œβ”€β”€ llm_helperβ”œβ”€β”€ code2docs/    β”œβ”€β”€ __main__    β”œβ”€β”€ 04_sync_and_watch    β”œβ”€β”€ 05_custom_generators    β”œβ”€β”€ 06_formatters    β”œβ”€β”€ 03_programmatic_api    β”œβ”€β”€ entry_points    β”œβ”€β”€ 07_web_frameworks    β”œβ”€β”€ class_examples    β”œβ”€β”€ basic_usage    β”œβ”€β”€ 01_cli_usage    β”œβ”€β”€ 02_configuration        β”œβ”€β”€ updater    β”œβ”€β”€ sync/        β”œβ”€β”€ watcher        β”œβ”€β”€ differ        β”œβ”€β”€ quickstart    β”œβ”€β”€ base        β”œβ”€β”€ advanced_usage        β”œβ”€β”€ badges        β”œβ”€β”€ markdown    β”œβ”€β”€ formatters/        β”œβ”€β”€ toc        β”œβ”€β”€ coverage_gen        β”œβ”€β”€ _source_links        β”œβ”€β”€ depgraph_gen        β”œβ”€β”€ getting_started_gen        β”œβ”€β”€ config_docs_gen        β”œβ”€β”€ changelog_gen    β”œβ”€β”€ generators/        β”œβ”€β”€ code2llm_gen        β”œβ”€β”€ module_docs_gen        β”œβ”€β”€ api_reference_gen        β”œβ”€β”€ examples_gen        β”œβ”€β”€ mkdocs_gen    β”œβ”€β”€ config        β”œβ”€β”€ api_changelog_gen        β”œβ”€β”€ _registry_adapters        β”œβ”€β”€ contributing_gen        β”œβ”€β”€ readme_gen    β”œβ”€β”€ analyzers/        β”œβ”€β”€ docstring_extractor        β”œβ”€β”€ endpoint_detector        β”œβ”€β”€ architecture_gen        β”œβ”€β”€ project_scanner    β”œβ”€β”€ cli        β”œβ”€β”€ dependency_scanner```

## Requirements

- Python >= >=3.9
- code2llm >=0.5.0- jinja2 >=3.1- click >=8.0- pyyaml >=6.0- rich >=13.0

## Contributing

**Contributors:**
- Tom Softreck <tom@sapletta.com>
- Tom Sapletta <tom-sapletta-com@users.noreply.github.com>

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

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

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

## Architecture

code2docs/
β”œβ”€β”€ cli.py # CLI (click-based)
β”œβ”€β”€ config.py # Configuration (code2docs.yaml)
β”œβ”€β”€ analyzers/ # Adapters to code2llm + custom detectors
β”‚ β”œβ”€β”€ project_scanner.py # Wrapper on code2llm.ProjectAnalyzer
β”‚ β”œβ”€β”€ endpoint_detector.py # Flask/FastAPI/Django route extraction
β”‚ β”œβ”€β”€ docstring_extractor.py
β”‚ └── dependency_scanner.py
β”œβ”€β”€ generators/ # Documentation generators
β”‚ β”œβ”€β”€ readme_gen.py # README.md generator
β”‚ β”œβ”€β”€ api_reference_gen.py # docs/api/ reference from signatures
β”‚ β”œβ”€β”€ module_docs_gen.py # docs/modules/ per-module docs
β”‚ β”œβ”€β”€ examples_gen.py # examples/ from signatures
β”‚ β”œβ”€β”€ changelog_gen.py # CHANGELOG from git log
β”‚ └── architecture_gen.py # Architecture + Mermaid diagrams
β”œβ”€β”€ templates/ # Jinja2 templates
β”œβ”€β”€ sync/ # Change detection & selective regeneration
β”‚ β”œβ”€β”€ differ.py
β”‚ β”œβ”€β”€ updater.py
β”‚ └── watcher.py
└── formatters/ # Markdown, badges, TOC



## Requirements

- Python >= 3.9
- [code2llm](https://github.com/wronai/code2llm) >= 0.5.0
- Jinja2 >= 3.1
- Click >= 8.0
- PyYAML >= 6.0

## License

Licensed under Apache-2.0.
## Status

_Last updated by [taskill](https://github.com/oqlos/taskill) at 2026-04-25 18:20 UTC_

| Metric | Value |
|---|---|
| HEAD | `42f2ec4` |
| Coverage | β€” |
| Failing tests | β€” |
| Commits in last cycle | 0 |

> No commits or file changes since the last run. The project state is unchanged; TODO.md shows a number of completed lints/tasks but there are still active issues to address.

<!-- taskill:status:end -->