code2docs 0.1.3__tar.gz → 0.1.4__tar.gz

{code2docs-0.1.3 → code2docs-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code2docs
-Version: 0.1.3
+Version: 0.1.4
 Summary: Auto-generate and sync project documentation from source code analysis
 Author-email: Tom Sapletta <tom@sapletta.com>
 License-Expression: Apache-2.0
@@ -40,7 +40,7 @@ Dynamic: license-file
 
 # code2docs
 
-![version](https://img.shields.io/badge/version-0.1.3-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.1.4-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.
 

{code2docs-0.1.3 → code2docs-0.1.4}/README.md

@@ -1,6 +1,6 @@
 # code2docs
 
-![version](https://img.shields.io/badge/version-0.1.3-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.1.4-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.
 

{code2docs-0.1.3 → code2docs-0.1.4}/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__ = "0.1.3"
+__version__ = "0.1.4"
 __author__ = "Tom Sapletta"
 
 from .config import Code2DocsConfig

code2docs-0.1.4/code2docs/generators/coverage_gen.py

@@ -0,0 +1,85 @@
+"""Docstring coverage report generator."""
+
+from typing import Dict, List
+
+from code2llm.api import AnalysisResult
+
+from ..config import Code2DocsConfig
+from ..analyzers.docstring_extractor import DocstringExtractor
+
+
+class CoverageGenerator:
+    """Generate docs/coverage.md — docstring coverage report."""
+
+    def __init__(self, config: Code2DocsConfig, result: AnalysisResult):
+        self.config = config
+        self.result = result
+        self._extractor = DocstringExtractor()
+
+    def generate(self) -> str:
+        """Generate coverage.md content."""
+        project_name = self.config.project_name or "Project"
+        report = self._extractor.coverage_report(self.result)
+
+        lines = [
+            f"# {project_name} — Docstring Coverage\n",
+            self._render_summary(report),
+            "",
+            "## Per-Module Breakdown\n",
+            self._render_per_module(),
+            "",
+            "## Undocumented Items\n",
+            self._render_undocumented(),
+            "",
+        ]
+        return "\n".join(lines)
+
+    @staticmethod
+    def _render_summary(report: Dict[str, float]) -> str:
+        """Render overall coverage summary."""
+        overall = report.get("overall_coverage", 0)
+        badge = "🟢" if overall >= 80 else "🟡" if overall >= 50 else "🔴"
+        lines = [
+            f"{badge} **Overall coverage: {overall:.1f}%**\n",
+            "| Category | Documented | Total | Coverage |",
+            "|----------|-----------|-------|----------|",
+            f"| Functions | {report['functions_documented']} | {report['functions_total']} | {report['functions_coverage']:.1f}% |",
+            f"| Classes | {report['classes_documented']} | {report['classes_total']} | {report['classes_coverage']:.1f}% |",
+        ]
+        return "\n".join(lines)
+
+    def _render_per_module(self) -> str:
+        """Render per-module coverage table."""
+        rows: List[str] = [
+            "| Module | Functions | Classes | Coverage |",
+            "|--------|-----------|---------|----------|",
+        ]
+        for mod_name in sorted(self.result.modules.keys()):
+            funcs = [f for f in self.result.functions.values()
+                     if f.module == mod_name and not f.is_method]
+            classes = [c for c in self.result.classes.values()
+                       if c.module == mod_name]
+            total = len(funcs) + len(classes)
+            documented = (sum(1 for f in funcs if f.docstring) +
+                          sum(1 for c in classes if c.docstring))
+            pct = (documented / total * 100) if total else 100.0
+            badge = "🟢" if pct >= 80 else "🟡" if pct >= 50 else "🔴"
+            rows.append(
+                f"| `{mod_name}` | {sum(1 for f in funcs if f.docstring)}/{len(funcs)} "
+                f"| {sum(1 for c in classes if c.docstring)}/{len(classes)} "
+                f"| {badge} {pct:.0f}% |"
+            )
+        return "\n".join(rows)
+
+    def _render_undocumented(self) -> str:
+        """List all undocumented public functions and classes."""
+        items: List[str] = []
+        for name, func in sorted(self.result.functions.items()):
+            if not func.docstring and not func.is_private and not func.is_method:
+                items.append(f"- `{name}` ({func.file}:{func.line})")
+        for name, cls in sorted(self.result.classes.items()):
+            if not cls.docstring:
+                items.append(f"- `{name}` ({cls.file}:{cls.line})")
+        if not items:
+            return "_All public items are documented._ ✅"
+        return "\n".join(items)

code2docs-0.1.4/code2docs/generators/depgraph_gen.py

@@ -0,0 +1,112 @@
+"""Dependency graph generator — Mermaid diagram from coupling matrix."""
+
+from typing import Dict, List, Set, Tuple
+
+from code2llm.api import AnalysisResult, ModuleInfo
+
+from ..config import Code2DocsConfig
+
+
+class DepGraphGenerator:
+    """Generate docs/dependency-graph.md with Mermaid diagrams."""
+
+    def __init__(self, config: Code2DocsConfig, result: AnalysisResult):
+        self.config = config
+        self.result = result
+
+    def generate(self) -> str:
+        """Generate dependency-graph.md content."""
+        project_name = self.config.project_name or "Project"
+        edges = self._collect_edges()
+        in_degree, out_degree = self._calc_degrees(edges)
+
+        lines = [
+            f"# {project_name} — Dependency Graph\n",
+            f"> {len(self.result.modules)} modules, "
+            f"{len(edges)} dependency edges\n",
+            "## Module Dependencies\n",
+            self._render_mermaid(edges),
+            "",
+            "## Coupling Matrix\n",
+            self._render_matrix(edges),
+            "",
+            "## Fan-in / Fan-out\n",
+            self._render_degree_table(in_degree, out_degree),
+            "",
+        ]
+        return "\n".join(lines)
+
+    def _collect_edges(self) -> List[Tuple[str, str]]:
+        """Build directed edges from module imports."""
+        edges: List[Tuple[str, str]] = []
+        module_names = set(self.result.modules.keys())
+
+        for mod_name, mod_info in self.result.modules.items():
+            for imp in mod_info.imports:
+                for other in module_names:
+                    if mod_name != other and self._import_matches(imp, other):
+                        edges.append((mod_name, other))
+        return sorted(set(edges))
+
+    @staticmethod
+    def _import_matches(imp: str, module: str) -> bool:
+        """Check if an import string refers to a known module."""
+        return imp == module or imp.startswith(module + ".")
+
+    def _render_mermaid(self, edges: List[Tuple[str, str]]) -> str:
+        """Render Mermaid graph from edges."""
+        lines = ["```mermaid", "graph LR"]
+        for src, tgt in edges:
+            s = src.split(".")[-1]
+            t = tgt.split(".")[-1]
+            lines.append(f"    {s} --> {t}")
+        if not edges:
+            lines.append("    note[No internal dependencies]")
+        lines.append("```")
+        return "\n".join(lines)
+
+    def _render_matrix(self, edges: List[Tuple[str, str]]) -> str:
+        """Render a coupling matrix as a Markdown table."""
+        mods = sorted(self.result.modules.keys())
+        if not mods:
+            return "_No modules._"
+        short = {m: m.split(".")[-1] for m in mods}
+        edge_set = set(edges)
+
+        header = "| | " + " | ".join(short[m] for m in mods) + " |"
+        sep = "| --- | " + " | ".join("---" for _ in mods) + " |"
+        rows = [header, sep]
+        for src in mods:
+            cells = []
+            for tgt in mods:
+                if src == tgt:
+                    cells.append("·")
+                elif (src, tgt) in edge_set:
+                    cells.append("→")
+                else:
+                    cells.append("")
+            rows.append(f"| **{short[src]}** | " + " | ".join(cells) + " |")
+        return "\n".join(rows)
+
+    @staticmethod
+    def _calc_degrees(edges: List[Tuple[str, str]]) -> Tuple[Dict[str, int], Dict[str, int]]:
+        """Calculate in-degree and out-degree per module."""
+        in_deg: Dict[str, int] = {}
+        out_deg: Dict[str, int] = {}
+        for src, tgt in edges:
+            out_deg[src] = out_deg.get(src, 0) + 1
+            in_deg[tgt] = in_deg.get(tgt, 0) + 1
+        return in_deg, out_deg
+
+    def _render_degree_table(self, in_deg: Dict[str, int], out_deg: Dict[str, int]) -> str:
+        """Render fan-in/fan-out table."""
+        mods = sorted(self.result.modules.keys())
+        lines = [
+            "| Module | Fan-in | Fan-out |",
+            "|--------|--------|---------|",
+        ]
+        for m in mods:
+            fi = in_deg.get(m, 0)
+            fo = out_deg.get(m, 0)
+            lines.append(f"| `{m}` | {fi} | {fo} |")
+        return "\n".join(lines)

code2docs-0.1.4/code2docs/generators/mkdocs_gen.py

@@ -0,0 +1,79 @@
+"""MkDocs configuration generator — auto-generate mkdocs.yml from docs tree."""
+
+from pathlib import Path
+from typing import Dict, List, Optional
+
+import yaml
+
+from code2llm.api import AnalysisResult
+
+from ..config import Code2DocsConfig
+
+
+class MkDocsGenerator:
+    """Generate mkdocs.yml from the docs/ directory structure."""
+
+    def __init__(self, config: Code2DocsConfig, result: AnalysisResult):
+        self.config = config
+        self.result = result
+
+    def generate(self, docs_dir: Optional[str] = None) -> str:
+        """Generate mkdocs.yml content."""
+        project_name = self.config.project_name or "Project"
+        nav = self._build_nav(docs_dir)
+
+        data = {
+            "site_name": f"{project_name} Documentation",
+            "theme": {"name": "material"},
+            "nav": nav,
+            "markdown_extensions": [
+                "admonition",
+                "pymdownx.highlight",
+                "pymdownx.superfences",
+                {"pymdownx.superfences": {
+                    "custom_fences": [{
+                        "name": "mermaid",
+                        "class": "mermaid",
+                        "format": "!!python/name:pymdownx.superfences.fence_code_format",
+                    }]
+                }},
+            ],
+        }
+        return yaml.dump(data, default_flow_style=False, sort_keys=False)
+
+    def _build_nav(self, docs_dir: Optional[str] = None) -> List:
+        """Build navigation structure from docs tree and analysis."""
+        nav: List = [{"Home": "index.md"}]
+
+        if self.config.docs.architecture:
+            nav.append({"Architecture": "architecture.md"})
+
+        # API reference
+        if self.config.docs.api_reference:
+            api_items = [{"Overview": "api/index.md"}]
+            for mod_name in sorted(self.result.modules.keys()):
+                safe = mod_name.replace(".", "_").replace("/", "_")
+                api_items.append({mod_name: f"api/module_{safe}.md"})
+            nav.append({"API Reference": api_items})
+
+        # Module docs
+        if self.config.docs.module_docs:
+            mod_items = []
+            for mod_name in sorted(self.result.modules.keys()):
+                safe = mod_name.replace(".", "_").replace("/", "_")
+                mod_items.append({mod_name: f"modules/{safe}.md"})
+            if mod_items:
+                nav.append({"Modules": mod_items})
+
+        # Extra pages
+        nav.append({"Dependency Graph": "dependency-graph.md"})
+        nav.append({"Coverage": "coverage.md"})
+
+        if self.config.docs.changelog:
+            nav.append({"Changelog": "changelog.md"})
+
+        return nav
+
+    def write(self, output_path: str, content: str) -> None:
+        """Write mkdocs.yml file."""
+        Path(output_path).write_text(content, encoding="utf-8")

{code2docs-0.1.3 → code2docs-0.1.4}/code2docs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code2docs
-Version: 0.1.3
+Version: 0.1.4
 Summary: Auto-generate and sync project documentation from source code analysis
 Author-email: Tom Sapletta <tom@sapletta.com>
 License-Expression: Apache-2.0
@@ -40,7 +40,7 @@ Dynamic: license-file
 
 # code2docs
 
-![version](https://img.shields.io/badge/version-0.1.3-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.1.4-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.
 

{code2docs-0.1.3 → code2docs-0.1.4}/code2docs.egg-info/SOURCES.txt

@@ -24,7 +24,10 @@ code2docs/generators/__init__.py
 code2docs/generators/api_reference_gen.py
 code2docs/generators/architecture_gen.py
 code2docs/generators/changelog_gen.py
+code2docs/generators/coverage_gen.py
+code2docs/generators/depgraph_gen.py
 code2docs/generators/examples_gen.py
+code2docs/generators/mkdocs_gen.py
 code2docs/generators/module_docs_gen.py
 code2docs/generators/readme_gen.py
 code2docs/sync/__init__.py

{code2docs-0.1.3 → code2docs-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "code2docs"
-version = "0.1.3"
+version = "0.1.4"
 description = "Auto-generate and sync project documentation from source code analysis"
 readme = "README.md"
 requires-python = ">=3.9"