code2docs 3.0.29__py3-none-any.whl → 3.0.30__py3-none-any.whl

code2docs/__init__.py

@@ -5,7 +5,7 @@ Uses code2llm's AnalysisResult to produce human-readable documentation:
 README.md, API references, module docs, examples, and architecture diagrams.
 """
 
-__version__ = '3.0.29'
+__version__ = '3.0.30'
 __author__ = 'Tom Sapletta'
 __all__ = ['Code2DocsConfig', 'generate_readme', 'generate_docs', 'analyze_and_document']
 

code2docs/analyzers/__init__.py

@@ -4,10 +4,20 @@ from .project_scanner import ProjectScanner
 from .endpoint_detector import EndpointDetector
 from .docstring_extractor import DocstringExtractor
 from .dependency_scanner import DependencyScanner
+from .markdown_validator import (
+    MarkdownIssue,
+    ValidationReport,
+    validate_markdown_file,
+    validate_markdown_tree,
+)
 
 __all__ = [
     "ProjectScanner",
     "EndpointDetector",
     "DocstringExtractor",
     "DependencyScanner",
+    "MarkdownIssue",
+    "ValidationReport",
+    "validate_markdown_file",
+    "validate_markdown_tree",
 ]

code2docs/analyzers/dependency_scanner.py

@@ -1,4 +1,4 @@
-"""Scan project dependencies from requirements.txt, pyproject.toml, setup.py, package.json, Cargo.toml, go.mod."""
+"""Scan project dependencies from requirements.txt, pyproject.toml, setup.py, package.json, composer.json, Cargo.toml, go.mod."""
 import re
 from dataclasses import dataclass, field
 from pathlib import Path
@@ -50,6 +50,11 @@ class DependencyScanner:
             if tsconfig.exists():
                 deps.language = 'typescript'
             return deps
+        composer_json = project / 'composer.json'
+        if composer_json.exists():
+            deps = self._parse_composer_json(composer_json)
+            deps.source_file = 'composer.json'
+            return deps
         cargo_toml = project / 'Cargo.toml'
         if cargo_toml.exists():
             deps = self._parse_cargo_toml(cargo_toml)
@@ -171,6 +176,26 @@ class DependencyScanner:
             deps.keywords = data.get('keywords', [])
         return deps
 
+    def _parse_composer_json(self, path: Path) -> ProjectDependencies:
+        """Parse composer.json for PHP dependencies."""
+        import json
+        deps = ProjectDependencies(language='php')
+        try:
+            data = json.loads(path.read_text(encoding='utf-8'))
+        except (json.JSONDecodeError, OSError):
+            return deps
+        deps.version = data.get('version', '')
+        deps.keywords = data.get('keywords', []) or []
+        for dep_name, ver in (data.get('require', {}) or {}).items():
+            if dep_name.lower() == 'php':
+                deps.runtime_version = ver
+                continue
+            deps.dependencies.append(DependencyInfo(name=dep_name, version_spec=ver))
+        for dep_name, ver in (data.get('require-dev', {}) or {}).items():
+            deps.dev_dependencies.append(DependencyInfo(name=dep_name, version_spec=ver, group='dev'))
+        deps.install_command = 'composer install'
+        return deps
+
     def _parse_cargo_toml(self, path: Path) -> ProjectDependencies:
         """Parse Cargo.toml for Rust dependencies."""
         deps = ProjectDependencies(language='rust')

code2docs/analyzers/markdown_validator.py

@@ -0,0 +1,194 @@
+"""Validate generated markdown: checks local links/images, table shape, duplicate headings."""
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import Iterable, List, Optional
+from urllib.parse import urlparse
+
+_LINK_RE = re.compile(r'!?\[([^\]]*)\]\(([^)\s]+)(?:\s+"[^"]*")?\)')
+_HEADING_RE = re.compile(r'^(#{1,6})\s+(.+?)\s*#*\s*$')
+_FENCE_RE = re.compile(r'^(```|~~~)')
+_TABLE_SEP_RE = re.compile(r'^\s*\|?\s*:?-{3,}:?\s*(\|\s*:?-{3,}:?\s*)+\|?\s*$')
+
+
+@dataclass
+class MarkdownIssue:
+    """A single validation issue in a markdown file."""
+    file: str
+    line: int
+    kind: str
+    message: str
+
+    def __str__(self) -> str:
+        return f'{self.file}:{self.line} [{self.kind}] {self.message}'
+
+
+@dataclass
+class ValidationReport:
+    """Aggregate result of markdown validation."""
+    issues: List[MarkdownIssue] = field(default_factory=list)
+    files_checked: int = 0
+
+    @property
+    def ok(self) -> bool:
+        return not self.issues
+
+    def by_kind(self, kind: str) -> List[MarkdownIssue]:
+        return [i for i in self.issues if i.kind == kind]
+
+    def summary(self) -> str:
+        if self.ok:
+            return f'✅ {self.files_checked} file(s) checked, no issues'
+        kinds: dict = {}
+        for issue in self.issues:
+            kinds[issue.kind] = kinds.get(issue.kind, 0) + 1
+        parts = ', '.join(f'{k}={v}' for k, v in sorted(kinds.items()))
+        return f'❌ {len(self.issues)} issue(s) across {self.files_checked} file(s): {parts}'
+
+
+def validate_markdown_file(md_path: Path, project_root: Optional[Path] = None) -> List[MarkdownIssue]:
+    """Validate a single markdown file.
+
+    Checks:
+    - Local links/images resolve to existing files (skips URLs and in-page anchors).
+    - Tables have consistent column count.
+    - Duplicate headings at the same level are flagged.
+    """
+    md_path = Path(md_path)
+    if not md_path.exists():
+        return [MarkdownIssue(str(md_path), 0, 'missing', 'file does not exist')]
+    root = Path(project_root) if project_root else md_path.parent
+    try:
+        lines = md_path.read_text(encoding='utf-8').splitlines()
+    except OSError as exc:
+        return [MarkdownIssue(str(md_path), 0, 'read_error', str(exc))]
+    issues: List[MarkdownIssue] = []
+    issues.extend(_check_links(md_path, root, lines))
+    issues.extend(_check_tables(md_path, lines))
+    issues.extend(_check_headings(md_path, lines))
+    return issues
+
+
+def validate_markdown_tree(root: Path, patterns: Iterable[str] = ('*.md',),
+                           ignore: Iterable[str] = ('node_modules', 'venv', '.venv',
+                                                    'vendor', '.git', '__pycache__')) -> ValidationReport:
+    """Validate every markdown file under ``root`` matching ``patterns``."""
+    root = Path(root)
+    ignore_set = set(ignore)
+    report = ValidationReport()
+    seen: set = set()
+    for pattern in patterns:
+        for md_file in root.rglob(pattern):
+            if any(part in ignore_set for part in md_file.parts):
+                continue
+            if md_file in seen:
+                continue
+            seen.add(md_file)
+            report.files_checked += 1
+            report.issues.extend(validate_markdown_file(md_file, project_root=root))
+    return report
+
+
+def _strip_code_fences(lines: List[str]) -> List[bool]:
+    """Return a per-line boolean: True if the line is inside a fenced code block."""
+    inside = False
+    mask: List[bool] = []
+    for line in lines:
+        if _FENCE_RE.match(line.strip()):
+            mask.append(True)
+            inside = not inside
+            continue
+        mask.append(inside)
+    return mask
+
+
+def _check_links(md_path: Path, root: Path, lines: List[str]) -> List[MarkdownIssue]:
+    issues: List[MarkdownIssue] = []
+    in_code = _strip_code_fences(lines)
+    for lineno, line in enumerate(lines, 1):
+        if in_code[lineno - 1]:
+            continue
+        for match in _LINK_RE.finditer(line):
+            target = match.group(2).strip()
+            if not target or target.startswith('#'):
+                continue
+            parsed = urlparse(target)
+            if parsed.scheme in ('http', 'https', 'mailto', 'ftp', 'tel', 'data'):
+                continue
+            if parsed.scheme and parsed.scheme not in ('file',):
+                continue
+            rel = parsed.path
+            if not rel:
+                continue
+            if rel.startswith('/'):
+                resolved = root / rel.lstrip('/')
+            else:
+                resolved = (md_path.parent / rel).resolve()
+            if not resolved.exists():
+                issues.append(MarkdownIssue(
+                    str(md_path), lineno, 'broken_link',
+                    f'link target not found: {target}'))
+    return issues
+
+
+def _check_tables(md_path: Path, lines: List[str]) -> List[MarkdownIssue]:
+    issues: List[MarkdownIssue] = []
+    in_code = _strip_code_fences(lines)
+    i = 0
+    while i < len(lines):
+        if in_code[i]:
+            i += 1
+            continue
+        line = lines[i]
+        if '|' in line and i + 1 < len(lines) and _TABLE_SEP_RE.match(lines[i + 1]):
+            header_cols = _count_cells(line)
+            sep_cols = _count_cells(lines[i + 1])
+            if header_cols != sep_cols:
+                issues.append(MarkdownIssue(
+                    str(md_path), i + 2, 'table_shape',
+                    f'separator has {sep_cols} cells, header has {header_cols}'))
+            j = i + 2
+            while j < len(lines) and not in_code[j] and lines[j].strip() and '|' in lines[j]:
+                cells = _count_cells(lines[j])
+                if cells != header_cols:
+                    issues.append(MarkdownIssue(
+                        str(md_path), j + 1, 'table_shape',
+                        f'row has {cells} cells, expected {header_cols}'))
+                j += 1
+            i = j
+        else:
+            i += 1
+    return issues
+
+
+def _count_cells(row: str) -> int:
+    stripped = row.strip()
+    if stripped.startswith('|'):
+        stripped = stripped[1:]
+    if stripped.endswith('|'):
+        stripped = stripped[:-1]
+    return len(stripped.split('|'))
+
+
+def _check_headings(md_path: Path, lines: List[str]) -> List[MarkdownIssue]:
+    issues: List[MarkdownIssue] = []
+    in_code = _strip_code_fences(lines)
+    seen: dict = {}
+    for lineno, line in enumerate(lines, 1):
+        if in_code[lineno - 1]:
+            continue
+        match = _HEADING_RE.match(line)
+        if not match:
+            continue
+        level = len(match.group(1))
+        title = match.group(2).strip().lower()
+        key = (level, title)
+        if key in seen:
+            issues.append(MarkdownIssue(
+                str(md_path), lineno, 'duplicate_heading',
+                f'H{level} "{match.group(2).strip()}" already at line {seen[key]}'))
+        else:
+            seen[key] = lineno
+    return issues

code2docs/config.py

@@ -14,7 +14,7 @@ except ImportError:
 @dataclass
 class ReadmeConfig:
     """Configuration for README generation."""
-    sections: List[str] = field(default_factory=lambda: ['overview', 'install', 'quickstart', 'generated_output', 'config', 'sync_markers', 'architecture', 'api', 'structure', 'requirements', 'contributing', 'docs_nav'])
+    sections: List[str] = field(default_factory=lambda: ['overview', 'install', 'quickstart', 'architecture', 'api', 'structure', 'requirements', 'endpoints', 'contributing', 'docs_nav'])
     badges: List[str] = field(default_factory=lambda: ['version', 'python', 'coverage', 'complexity'])
     sync_markers: bool = True
 

code2docs/formatters/badges.py

@@ -27,6 +27,9 @@ def _make_badge(badge_type: str, project_name: str,
         return f"![version](https://img.shields.io/badge/version-0.1.0-blue)"
 
     elif badge_type == "python":
+        lang = getattr(deps, "language", "python") if deps else "python"
+        if lang and lang != "python":
+            return _runtime_badge(lang, deps)
         py_version = ""
         if deps and hasattr(deps, "python_version"):
             py_version = deps.python_version
@@ -50,3 +53,20 @@ def _make_badge(badge_type: str, project_name: str,
         return f"![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)"
 
     return None
+
+
+_RUNTIME_LABELS = {
+    "php": ("php", "777BB4"),
+    "javascript": ("node", "339933"),
+    "typescript": ("typescript", "3178C6"),
+    "rust": ("rust", "B7410E"),
+    "go": ("go", "00ADD8"),
+}
+
+
+def _runtime_badge(lang: str, deps) -> Optional[str]:
+    """Generate a runtime badge for non-Python languages."""
+    label, color = _RUNTIME_LABELS.get(lang, (lang, "blue"))
+    version = getattr(deps, "runtime_version", "") if deps else ""
+    version = version or "any"
+    return f"![{label}](https://img.shields.io/badge/{quote(label)}-{quote(version)}-{color})"

code2docs/generators/readme_gen.py

@@ -57,7 +57,9 @@ class ReadmeGenerator:
         project_description = self._generate_description(project_name, entry_points)
         metadata = self._extract_project_metadata()
         extras = self._extract_extras()
-        return {'project_name': project_name, 'project_path': self.result.project_path, 'project_description': project_description, 'badges': generate_badges(project_name, self.config.readme.badges, stats, deps), 'stats': stats, 'avg_complexity': avg_complexity, 'dependencies': deps, 'endpoints': endpoints, 'public_functions': public_functions, 'public_classes': public_classes, 'entry_points': entry_points, 'module_tree': module_tree, 'modules': self.result.modules, 'sync_markers': self.config.readme.sync_markers, 'author': metadata.get('author', ''), 'license': metadata.get('license', ''), 'license_file': metadata.get('license_file', ''), 'contributors': metadata.get('contributors', []), 'repo_url': self.config.repo_url, 'version': metadata.get('version', '0.1.0'), 'extras': extras}
+        lang = getattr(deps, 'language', 'python') or 'python'
+        docs_nav_items, generated_files = self._collect_existing_docs()
+        return {'docs_nav_items': docs_nav_items, 'generated_files': generated_files, 'project_name': project_name, 'project_path': self.result.project_path, 'project_description': project_description, 'badges': generate_badges(project_name, self.config.readme.badges, stats, deps), 'stats': stats, 'avg_complexity': avg_complexity, 'dependencies': deps, 'language': lang, 'endpoints': endpoints, 'public_functions': public_functions, 'public_classes': public_classes, 'entry_points': entry_points, 'module_tree': module_tree, 'modules': self.result.modules, 'sync_markers': self.config.readme.sync_markers, 'author': metadata.get('author', ''), 'license': metadata.get('license', ''), 'license_file': metadata.get('license_file', ''), 'contributors': metadata.get('contributors', []), 'repo_url': self.config.repo_url, 'version': metadata.get('version', '0.1.0'), 'extras': extras}
 
     def _calc_avg_complexity(self) -> float:
         """Calculate average cyclomatic complexity."""

code2docs/templates/readme.md.j2

@@ -23,6 +23,50 @@
 {% if "install" in sections %}
 ## Installation
 
+{% if language == 'php' %}
+### Requirements
+
+{% if dependencies and dependencies.runtime_version %}- PHP {{ dependencies.runtime_version }}
+{% else %}- PHP 8.0+
+{% endif %}- [Composer](https://getcomposer.org/)
+
+### From Source
+
+```bash
+git clone {{ repo_url or '<repository-url>' }}
+cd {{ project_name }}
+composer install
+```
+{% elif language in ('javascript', 'typescript') %}
+### Requirements
+
+{% if dependencies and dependencies.runtime_version %}- Node.js {{ dependencies.runtime_version }}
+{% else %}- Node.js 18+
+{% endif %}
+### From Source
+
+```bash
+git clone {{ repo_url or '<repository-url>' }}
+cd {{ project_name }}
+{{ dependencies.install_command if dependencies and dependencies.install_command else 'npm install' }}
+```
+{% elif language == 'rust' %}
+### From Source
+
+```bash
+git clone {{ repo_url or '<repository-url>' }}
+cd {{ project_name }}
+cargo build --release
+```
+{% elif language == 'go' %}
+### From Source
+
+```bash
+git clone {{ repo_url or '<repository-url>' }}
+cd {{ project_name }}
+go build ./...
+```
+{% else %}
 ### From PyPI
 
 ```bash
@@ -46,10 +90,37 @@ pip install -e .
 ```
 {% endif %}
 {% endif %}
+{% endif %}
 
 {% if "quickstart" in sections %}
 ## Quick Start
 
+{% if language == 'php' %}
+Serve the project with your preferred PHP runtime (built-in server shown for local development):
+
+```bash
+php -S localhost:8000
+```
+
+Or with Docker Compose if a `docker-compose.yml` is provided:
+
+```bash
+docker compose up
+```
+{% elif language in ('javascript', 'typescript') %}
+```bash
+{% if dependencies and dependencies.install_command %}{{ dependencies.install_command }}
+{% endif %}npm start
+```
+{% elif language == 'rust' %}
+```bash
+cargo run
+```
+{% elif language == 'go' %}
+```bash
+go run .
+```
+{% else %}
 ### CLI Usage
 
 ```bash
@@ -82,6 +153,7 @@ config = Code2DocsConfig(project_name="mylib", verbose=True)
 docs = generate_docs("./my-project", config=config)
 ```
 {% endif %}
+{% endif %}
 
 {% if "generated_output" in sections %}
 ## Generated Output
@@ -171,8 +243,12 @@ Content outside the markers is preserved when regenerating. Enable this with `sy
 
 ```
 {{ project_name }}/
-{% for mod_name, mod in modules.items()|list %}{% if not mod_name.startswith('_') %}{% set parts = mod_name.split('.') %}{{ '    ' * (parts|length - 1) }}├── {{ parts[-1] }}{% if mod.is_package %}/{% endif %}
-{% endif %}{% endfor %}
+{% for mod_name, mod in modules.items()|list -%}
+{% if not mod_name.startswith('_') -%}
+{% set parts = mod_name.split('.') -%}
+{{ '    ' * (parts|length - 1) }}├── {{ parts[-1] }}{% if mod.is_package %}/{% endif %}{{ "\n" -}}
+{% endif -%}
+{% endfor -%}
 ```
 {% endif %}
 
@@ -249,11 +325,31 @@ We welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for gu
 git clone {{ repo_url or '<repository-url>' }}
 cd {{ project_name }}
 
+{% if language == 'php' %}
+# Install dependencies
+composer install
+
+# Run tests
+vendor/bin/phpunit
+{% elif language in ('javascript', 'typescript') %}
+# Install dependencies
+{{ dependencies.install_command if dependencies and dependencies.install_command else 'npm install' }}
+
+# Run tests
+npm test
+{% elif language == 'rust' %}
+# Run tests
+cargo test
+{% elif language == 'go' %}
+# Run tests
+go test ./...
+{% else %}
 # Install in development mode
 pip install -e ".[dev]"
 
 # Run tests
 pytest
+{% endif %}
 ```
 {% endif %}
 

{code2docs-3.0.29.dist-info → code2docs-3.0.30.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code2docs
-Version: 3.0.29
+Version: 3.0.30
 Summary: Auto-generate and sync project documentation from source code analysis
 Author-email: Tom Sapletta <tom@sapletta.com>
 License-Expression: Apache-2.0
@@ -53,17 +53,17 @@ Dynamic: license-file
 
 ## AI Cost Tracking
 
-![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.29-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
-![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-23.8h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
+![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.30-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
+![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-24.3h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
 
-- 🤖 **LLM usage:** $7.5000 (68 commits)
-- 👤 **Human dev:** ~$2384 (23.8h @ $100/h, 30min dedup)
+- 🤖 **LLM usage:** $7.5000 (70 commits)
+- 👤 **Human dev:** ~$2434 (24.3h @ $100/h, 30min dedup)
 
-Generated on 2026-04-19 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
+Generated on 2026-04-20 using [openrouter/qwen/qwen3-coder-next](https://openrouter.ai/qwen/qwen3-coder-next)
 
 ---
 
-![version](https://img.shields.io/badge/version-3.0.29-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-3.0.30-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.
 
@@ -200,7 +200,7 @@ code2docs can update only specific sections of an existing README using markers:
 ```markdown
 <!-- code2docs:start --># code2docs
 
-![version](https://img.shields.io/badge/version-3.0.29-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)
+![version](https://img.shields.io/badge/version-3.0.30-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.

{code2docs-3.0.29.dist-info → code2docs-3.0.30.dist-info}/RECORD

@@ -1,19 +1,20 @@
-code2docs/__init__.py,sha256=V0SRmr0sXKrRuxD5v0-9_EIWSxr-Kqs5LSDlDEHD8uc,901
+code2docs/__init__.py,sha256=_pBUiOybWxKLxk_HHp5_JjIbjpAo-faaic7ZB0T3Fys,901
 code2docs/__main__.py,sha256=dGGkQIZVFDZXEXa9PWew7cBh7hBAYDWfJ9LeezMf2UI,116
 code2docs/base.py,sha256=tQT0I9iAxpxtCNHFZL8kYdgCD-96ywOvDKD2Iiksgj4,1319
 code2docs/cli.py,sha256=k1mhqb3ykeqpnSfolsZSn3lVPkR8wde9DQdKlON1w0o,11283
-code2docs/config.py,sha256=OL7FMOMkJ_nw01NKYxd17oKVzqk_BkVKDKCVuMUeVyo,8858
+code2docs/config.py,sha256=WH101glXT9chJH016g1z7uZy8l8dbNbhnN_rOU2BSsE,8825
 code2docs/llm_helper.py,sha256=2Q_pnOBeei9EVU9HL_dWmqUpdkSzYNlMfIr5OOQcLws,6155
 code2docs/registry.py,sha256=aD3pdTAF2VeTMVddoQdt6QCB9b15FQywLE0W8Uca0xk,1256
-code2docs/analyzers/__init__.py,sha256=lIvbHr8JCuYTd8QJNsR7RANLFdlpIMJEsv-lMO7Avdc,370
-code2docs/analyzers/dependency_scanner.py,sha256=BVbqR4iaIpWzazbBOjovuKdICJOP2YdMUQaWMdM9TTQ,10730
+code2docs/analyzers/__init__.py,sha256=4m_W6ch3mfNJVVk5CG5G4-kqA28KzPz_uvzYhznxj6Q,608
+code2docs/analyzers/dependency_scanner.py,sha256=cnsoggrEVSJV9jZFCyIIyJuJyEYqG8V0lig8EKo0ymE,11924
 code2docs/analyzers/docstring_extractor.py,sha256=gu2NqvnkFu8Mii1lxCZk1jBKNPkCVj09iiapaRrgX_Y,5060
 code2docs/analyzers/endpoint_detector.py,sha256=IlRY6vEw-uUy4CTN3AOEkM6IcohcMy0iZDOoQJxrrno,3827
+code2docs/analyzers/markdown_validator.py,sha256=TOkWcNzDdRkaLrCo2q-09YHj6iYj_JLBs8RH35q07UM,6974
 code2docs/analyzers/project_scanner.py,sha256=Ru86nrT_SyMN8wYuQ2tu0lK1WM7Z4K9zUXOmpNNDJ6Q,1599
 code2docs/examples/advanced_usage.py,sha256=sHyXrXV5p9t6B9OpZndPNrClBSSEzSmjlsvoMT7cp9k,2741
 code2docs/examples/quickstart.py,sha256=VDJfpRtMFZOBZAGXLkJ65ELUncjF7YM0x2vIm3aZmrA,1301
 code2docs/formatters/__init__.py,sha256=3-myGxFceSgOW3g1eQFUJO3tEDF03MbG-7WL1WEylk4,240
-code2docs/formatters/badges.py,sha256=zd3Us9n1-ZVcQTR9GtskHrwaBqBWcKJ_5wL_swNaQT8,1737
+code2docs/formatters/badges.py,sha256=wGBCKDu2bK3Lsiyus6b9ow1nHzgMlCPIagAdsmk8S1M,2461
 code2docs/formatters/markdown.py,sha256=yfmicI9-T0WnyFoZRe4XrB2Wc847kNqK7q0VSeP8zVg,2278
 code2docs/formatters/toc.py,sha256=EBynYUlgkk5W5_QqsRHWbIW2Cfpk3sJulk3FvURHK60,1770
 code2docs/generators/__init__.py,sha256=U1p6nY6pLLTXF7wY2TgnQ017bXZf3vtJ2iTAWsk4ejA,1988
@@ -33,7 +34,7 @@ code2docs/generators/getting_started_gen.py,sha256=P--4A0Lmeo338zKjuD1D5BYxVJ5IG
 code2docs/generators/mkdocs_gen.py,sha256=ciETCRUzb3V3kSGAslM5DStHJUQ1Ju-pTxC1Iv_duzo,3849
 code2docs/generators/module_docs_gen.py,sha256=6FFH69AQlNxPlEMEEeX0ND366rb7URSP6geNlvf_Sjk,10090
 code2docs/generators/org_readme_gen.py,sha256=Saf7iZbHwtXcqXAl1EYmufl6mZ4msc-SFsVWj1Zqptw,9411
-code2docs/generators/readme_gen.py,sha256=jVoS_j54S_l1k__saYlmXGnKtfk_sVN5no3Mp0UfnW8,17325
+code2docs/generators/readme_gen.py,sha256=ymxdPvNZdWhxLwwtJdX-CDjfj25BxGPugiaZ0P9Sbio,17548
 code2docs/sync/__init__.py,sha256=MOTJYvJXPZF-4PS47lv-6bOc9J2ZoQGoIchp3vIuwrU,162
 code2docs/sync/differ.py,sha256=3dtu95BiiTXaz8tU63Ot6_W9DAHdFoKVd3OIiFz7Qiw,4160
 code2docs/sync/updater.py,sha256=ZuRcVtoubxwPnuuTn8s05h1xLoSNwzaNlm_XKAJdf94,1971
@@ -43,10 +44,10 @@ code2docs/templates/architecture.md.j2,sha256=kx_lECcC9FGHTEnhgPNVGIijDFXu5xFcm4
 code2docs/templates/example_usage.py.j2,sha256=G0mF7iLtisnsh-PfPTMLgVoNSDw6J-MqPndzMTtcuJk,225
 code2docs/templates/index.md.j2,sha256=pj56gwiLuXxV64xVYfzmtboMLyFKF-Kty01Ps0t37xM,653
 code2docs/templates/module_doc.md.j2,sha256=oMcaDSSCbyMSjQtnal7garYr4dDbTcRAQobsjrYVYGo,1876
-code2docs/templates/readme.md.j2,sha256=uOSK5eWQ63jRYOzdPVbiTIvXUombw3juJQzJuqzrcT4,8346
-code2docs-3.0.29.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-code2docs-3.0.29.dist-info/METADATA,sha256=ALDqbCOjkG6EluJn4lZaCelfgOHGCAQLTaFLIoSMGks,26843
-code2docs-3.0.29.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-code2docs-3.0.29.dist-info/entry_points.txt,sha256=ATamjPNo2CbTaAUN3LfK8qrnY3EQE9gE7lMDgPYhLdQ,49
-code2docs-3.0.29.dist-info/top_level.txt,sha256=L-O2M4M-NSiphgcKSfXFsC-t6PqziMl8Ef6tsNR2DaM,10
-code2docs-3.0.29.dist-info/RECORD,,
+code2docs/templates/readme.md.j2,sha256=G_qgTt6aFv8ZnYZa7MSbBe4DB8RyXhHbVDR8OHFp-8k,10393
+code2docs-3.0.30.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+code2docs-3.0.30.dist-info/METADATA,sha256=9OEo5U-MeCLCL5TKlotFBB6TnBsZjPVAxlEb8KnadPs,26843
+code2docs-3.0.30.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+code2docs-3.0.30.dist-info/entry_points.txt,sha256=ATamjPNo2CbTaAUN3LfK8qrnY3EQE9gE7lMDgPYhLdQ,49
+code2docs-3.0.30.dist-info/top_level.txt,sha256=L-O2M4M-NSiphgcKSfXFsC-t6PqziMl8Ef6tsNR2DaM,10
+code2docs-3.0.30.dist-info/RECORD,,