docs(docs): code quality metrics with 5 supporting modules

changes:
  - file: readme_gen.py
    area: docs
    modified: [ReadmeGenerator, _extract_project_metadata]

stats:
  lines: "+58/-32 (net +26)"
  files: 6
  complexity: "+100% complexity (monitor)"

Author: tom-sapletta-com

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.7] - 2026-03-07
+
+### Docs
+- Update code2docs/README.md
+- Update code2docs/docs/api.md
+- Update code2docs/docs/architecture.md
+- Update code2docs/docs/configuration.md
+- Update code2docs/docs/modules.md
+
+### Other
+- Update code2docs/generators/readme_gen.py
+
 ## [0.2.6] - 2026-03-07
 
 ### Test

README.md

@@ -1,6 +1,6 @@
 # code2docs
 
-![version](https://img.shields.io/badge/version-0.2.6-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
+![version](https://img.shields.io/badge/version-0.2.7-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
 
 > Auto-generate and sync project documentation from source code analysis.
 
@@ -140,7 +140,7 @@ code2docs can update only specific sections of an existing README using markers:
 ```markdown
 <!-- code2docs:start --># code2docs
 
-![version](https://img.shields.io/badge/version-0.2.6-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-153-green)
+![version](https://img.shields.io/badge/version-0.2.7-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-153-green)
 > **153** functions | **30** classes | **28** files | CC̄ = 0.0
 
 ## Installation

VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

code2docs/README.md

@@ -6,7 +6,7 @@
 > Auto-generated project documentation from source code analysis.
 
 **Author:** Tom Softreck <tom@sapletta.com>  
-**License:** Not specified  
+**License:** MIT[(LICENSE)](./LICENSE)  
 **Repository:** [https://github.com/wronai/code2docs](https://github.com/wronai/code2docs)
 
 ## Installation
@@ -124,6 +124,25 @@ sync:
     - "__pycache__"
 ```
 
+## Sync Markers
+
+code2docs can update only specific sections of an existing README using HTML comment markers:
+
+```markdown
+<!-- 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/    ├── updater├── sync/    ├── watcher    ├── differ    ├── quickstart    ├── advanced_usage    ├── markdown    ├── badges    ├── toc├── formatters/    ├── readme_gen├── base    ├── coverage_gen    ├── _source_links    ├── depgraph_gen    ├── getting_started_gen    ├── config_docs_gen    ├── changelog_gen├── generators/    ├── module_docs_gen    ├── api_reference_gen    ├── mkdocs_gen    ├── examples_gen    ├── _registry_adapters├── cli    ├── api_changelog_gen    ├── contributing_gen├── analyzers/    ├── architecture_gen├── config    ├── project_scanner    ├── dependency_scanner    ├── endpoint_detector    ├── docstring_extractor```
+
 ## API Overview
 
 ### Classes
@@ -134,10 +153,10 @@ sync:
 - **`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.
 - **`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.
-- **`ReadmeGenerator`** — Generate README.md from AnalysisResult.
 - **`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.
@@ -160,11 +179,11 @@ sync:
 - **`GettingStartedAdapter`** — —
 - **`ConfigDocsAdapter`** — —
 - **`ContributingAdapter`** — —
+- **`DefaultGroup`** — Click Group that routes unknown subcommands to 'generate'.
 - **`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.
@@ -175,10 +194,10 @@ sync:
 - **`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.
+- **`DocstringInfo`** — Parsed docstring with sections.
+- **`DocstringExtractor`** — Extract and parse docstrings from AnalysisResult.
 
 ### Functions
 

code2docs/__init__.py

@@ -5,7 +5,7 @@
 README.md, API references, module docs, examples, and architecture diagrams.
 """
 
-__version__ = "0.2.6"
+__version__ = "0.2.7"
 __author__ = "Tom Sapletta"
 
 from .config import Code2DocsConfig

code2docs/docs/api.md

@@ -227,7 +227,7 @@
 | Function | Signature | CC | Description | Source |
 |----------|-----------|----|-----------  |--------|
 | `generate_docs` | `generate_docs(project_path, config)` | 5 | High-level function to generate all documentation. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/__init__.py#L35) |
-| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L428) |
+| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L439) |
 
 ### `llm_helper` [source](https://github.com/wronai/code2docs/blob/main/code2docs/llm_helper.py)
 
@@ -540,7 +540,7 @@
 
 | Function | Signature | CC | Description | Source |
 |----------|-----------|----|-----------  |--------|
-| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L428) |
+| `generate_readme` | `generate_readme(project_path, output, sections, sync_markers, ...)` | 3 | Convenience function to generate a README. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L439) |
 
 ## sync
 

code2docs/docs/architecture.md

@@ -297,7 +297,7 @@ classDiagram
 | Modules | 38 |
 | Functions | 229 |
 | Classes | 51 |
-| CFG Nodes | 1344 |
+| CFG Nodes | 1346 |
 | Patterns | 2 |
 | Avg Complexity | 4.0 |
-| Analysis Time | 1.31s |
+| Analysis Time | 1.92s |

code2docs/docs/configuration.md

@@ -24,7 +24,7 @@
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `sections` | `List` | overview, install, quickstart, generated_output, config, api, structure, requirements, contributing, docs_nav | README sections to include |
+| `sections` | `List` | overview, install, quickstart, generated_output, config, sync_markers, architecture, api, structure, requirements, contributing, docs_nav | README sections to include |
 | `badges` | `List` | version, python, coverage, complexity | Badge types to show in README header |
 | `sync_markers` | `bool` | true | Wrap generated content in `<!-- code2docs:start/end -->` markers |
 

code2docs/docs/modules.md

@@ -32,7 +32,7 @@
 | `generators.getting_started_gen` | 166 | 0 | 1 | 5.8 | Getting Started guide generator. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/getting_started_gen.py) |
 | `generators.mkdocs_gen` | 70 | 0 | 1 | 2.2 | MkDocs configuration generator — auto-generate mkdocs.yml fr | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/mkdocs_gen.py) |
 | `generators.module_docs_gen` | 198 | 0 | 1 | 8.0 | Module documentation generator — single consolidated modules | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/module_docs_gen.py) |
-| `generators.readme_gen` | 445 | 1 | 1 | 5.5 | README.md generator from AnalysisResult. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py) |
+| `generators.readme_gen` | 456 | 1 | 1 | 5.7 | README.md generator from AnalysisResult. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py) |
 | `llm_helper` | 161 | 1 | 1 | 2.3 | LLM helper — optional LLM-assisted documentation generation  | [source](https://github.com/wronai/code2docs/blob/main/code2docs/llm_helper.py) |
 | `registry` | 39 | 0 | 1 | 2.5 | Generator registry — pluggable generator system. | [source](https://github.com/wronai/code2docs/blob/main/code2docs/registry.py) |
 | `sync.differ` | 125 | 0 | 2 | 3.6 | Detect changes in source code for selective documentation re | [source](https://github.com/wronai/code2docs/blob/main/code2docs/sync/differ.py) |
@@ -494,7 +494,7 @@ README.md generator from AnalysisResult.
 | `generate` | `` | `—` | 3 |
 | `write` | `path, content` | `—` | 4 |
 
-- `generate_readme(project_path, output, sections, sync_markers, config)` — Convenience function to generate a README. [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L428)
+- `generate_readme(project_path, output, sections, sync_markers, config)` — Convenience function to generate a README. [source](https://github.com/wronai/code2docs/blob/main/code2docs/generators/readme_gen.py#L439)
 
 ## sync
 

code2docs/generators/readme_gen.py

@@ -192,27 +192,34 @@ def _extract_project_metadata(self) -> Dict:
         # Try pyproject.toml
         try:
             import tomllib
-            pyproject_path = Path(self.result.project_path) / "pyproject.toml"
-            if pyproject_path.exists():
-                with open(pyproject_path, "rb") as f:
-                    data = tomllib.load(f)
-
-                project = data.get("project", {})
-                metadata["version"] = project.get("version", metadata["version"])
-
-                # Authors
-                authors = project.get("authors", [])
-                if authors:
-                    if isinstance(authors[0], dict):
-                        metadata["author"] = authors[0].get("name", "")
-                        metadata["contributors"] = [a.get("name", "") for a in authors[1:] if a.get("name")]
+            pyproject_paths = [
+                Path(self.result.project_path) / "pyproject.toml",
+                Path(self.result.project_path).parent / "pyproject.toml",
+            ]
+            for pyproject_path in pyproject_paths:
+                if pyproject_path.exists():
+                    with open(pyproject_path, "rb") as f:
+                        data = tomllib.load(f)
+
+                    project = data.get("project", {})
+                    metadata["version"] = project.get("version", metadata["version"])
+
+                    # Authors
+                    authors = project.get("authors", [])
+                    if authors:
+                        if isinstance(authors[0], dict):
+                            metadata["author"] = authors[0].get("name", "")
+                            metadata["contributors"] = [a.get("name", "") for a in authors[1:] if a.get("name")]
+                        else:
+                            metadata["author"] = str(authors[0])
+
+                    # License
+                    lic = project.get("license", {})
+                    if isinstance(lic, dict):
+                        metadata["license"] = lic.get("text", "")
                     else:
-                        metadata["author"] = str(authors[0])
-
-                # License
-                metadata["license"] = project.get("license", {}).get("text", "")
-                if not metadata["license"]:
-                    metadata["license"] = project.get("license", "")
+                        metadata["license"] = lic
+                    break
         except Exception:
             pass