code2docs 3.0.20__tar.gz → 3.0.21__tar.gz

{code2docs-3.0.20 → code2docs-3.0.21}/PKG-INFO

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

@@ -1,6 +1,6 @@
 # code2docs
 
-![version](https://img.shields.io/badge/version-3.0.20-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.21-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-3.0.20-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.21-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.20 → code2docs-3.0.21}/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.20"
+__version__ = "3.0.21"
 __author__ = "Tom Sapletta"
 
 from .config import Code2DocsConfig

{code2docs-3.0.20 → code2docs-3.0.21}/code2docs/generators/_registry_adapters.py

@@ -250,25 +250,178 @@ class OrgReadmeAdapter(BaseGenerator):
 
     def run(self, ctx: GenerateContext) -> Optional[str]:
         from .org_readme_gen import OrgReadmeGenerator
-        
+
         org_name = getattr(self.config, 'org_name', '')
         if not org_name:
             return None
-            
+
         gen = OrgReadmeGenerator(self.config, str(ctx.project), org_name)
         content = gen.generate()
-        
+
         if ctx.dry_run:
             click.echo(f"\n--- {org_name} README ({len(content)} chars) ---")
             preview = content[:500] + "..." if len(content) > 500 else content
             click.echo(preview)
             return None
-        
+
         readme_path = ctx.docs_dir / "README.md"
         gen.write(str(readme_path), content)
         return f"✅ {readme_path.relative_to(ctx.project)}"
 
 
+class IndexHtmlAdapter(BaseGenerator):
+    """Adapter for generating index.html for GitHub Pages browsing."""
+    name = "index_html"
+
+    def should_run(self, *, readme_only: bool = False) -> bool:
+        return not readme_only
+
+    def run(self, ctx: GenerateContext) -> Optional[str]:
+        if ctx.dry_run:
+            return "[dry-run] docs/index.html"
+
+        content = self._generate_html(ctx)
+        (ctx.docs_dir / "index.html").write_text(content, encoding="utf-8")
+        return "✅ docs/index.html"
+
+    def _generate_html(self, ctx: GenerateContext) -> str:
+        project_name = self.config.project_name or ctx.project.name
+        repo_url = self.config.repo_url
+
+        files = []
+        if (ctx.docs_dir / "README.md").exists():
+            files.append(("README.md", "Project Overview", "📖"))
+        if (ctx.docs_dir / "getting-started.md").exists():
+            files.append(("getting-started.md", "Getting Started", "🚀"))
+        if (ctx.docs_dir / "api.md").exists():
+            files.append(("api.md", "API Reference", "📚"))
+        if (ctx.docs_dir / "modules.md").exists():
+            files.append(("modules.md", "Module Documentation", "📦"))
+        if (ctx.docs_dir / "architecture.md").exists():
+            files.append(("architecture.md", "Architecture", "🏗️"))
+        if (ctx.docs_dir / "dependency-graph.md").exists():
+            files.append(("dependency-graph.md", "Dependency Graph", "🔗"))
+        if (ctx.docs_dir / "coverage.md").exists():
+            files.append(("coverage.md", "Code Coverage", "📊"))
+        if (ctx.docs_dir / "api-changelog.md").exists():
+            files.append(("api-changelog.md", "API Changelog", "📝"))
+        if (ctx.docs_dir / "configuration.md").exists():
+            files.append(("configuration.md", "Configuration", "⚙️"))
+        if (ctx.docs_dir / "CONTRIBUTING.md").exists():
+            files.append(("CONTRIBUTING.md", "Contributing Guide", "🤝"))
+        if (ctx.docs_dir / "examples").is_dir():
+            files.append(("examples/", "Examples", "💡"))
+
+        github_link = f'<a href="{repo_url}" class="github-link" target="_blank" rel="noopener">View on GitHub</a>' if repo_url else ""
+
+        files_html = "\n".join(
+            f'<a href="{href}" class="doc-card"><span class="icon">{icon}</span><span class="title">{title}</span></a>'
+            for href, title, icon in files
+        )
+
+        return f'''<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{project_name} - Documentation</title>
+    <style>
+        * {{ margin: 0; padding: 0; box-sizing: border-box; }}
+        body {{
+            font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, sans-serif;
+            background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+            min-height: 100vh;
+            padding: 40px 20px;
+        }}
+        .container {{
+            max-width: 900px;
+            margin: 0 auto;
+        }}
+        .header {{
+            text-align: center;
+            margin-bottom: 40px;
+            color: white;
+        }}
+        .header h1 {{
+            font-size: 2.5rem;
+            margin-bottom: 10px;
+            text-shadow: 0 2px 4px rgba(0,0,0,0.2);
+        }}
+        .header p {{
+            font-size: 1.1rem;
+            opacity: 0.9;
+        }}
+        .github-link {{
+            display: inline-block;
+            margin-top: 15px;
+            padding: 10px 20px;
+            background: rgba(255,255,255,0.2);
+            color: white;
+            text-decoration: none;
+            border-radius: 25px;
+            transition: background 0.3s;
+        }}
+        .github-link:hover {{ background: rgba(255,255,255,0.3); }}
+        .docs-grid {{
+            display: grid;
+            grid-template-columns: repeat(auto-fill, minmax(250px, 1fr));
+            gap: 20px;
+        }}
+        .doc-card {{
+            background: white;
+            border-radius: 12px;
+            padding: 25px;
+            text-decoration: none;
+            color: #333;
+            box-shadow: 0 4px 15px rgba(0,0,0,0.1);
+            transition: transform 0.2s, box-shadow 0.2s;
+            display: flex;
+            align-items: center;
+            gap: 15px;
+        }}
+        .doc-card:hover {{
+            transform: translateY(-3px);
+            box-shadow: 0 8px 25px rgba(0,0,0,0.15);
+        }}
+        .doc-card .icon {{
+            font-size: 2rem;
+            flex-shrink: 0;
+        }}
+        .doc-card .title {{
+            font-size: 1.1rem;
+            font-weight: 600;
+        }}
+        .footer {{
+            text-align: center;
+            margin-top: 40px;
+            color: rgba(255,255,255,0.7);
+            font-size: 0.9rem;
+        }}
+        @media (max-width: 600px) {{
+            .header h1 {{ font-size: 1.8rem; }}
+            .docs-grid {{ grid-template-columns: 1fr; }}
+        }}
+    </style>
+</head>
+<body>
+    <div class="container">
+        <div class="header">
+            <h1>{project_name}</h1>
+            <p>Generated Documentation</p>
+            {github_link}
+        </div>
+        <div class="docs-grid">
+            {files_html}
+        </div>
+        <div class="footer">
+            Generated with <a href="https://github.com/wronai/code2docs" style="color: rgba(255,255,255,0.9);">code2docs</a>
+        </div>
+    </div>
+</body>
+</html>'''
+
+
+
 ALL_ADAPTERS = [
     ReadmeGeneratorAdapter,
     ApiReferenceAdapter,
@@ -284,4 +437,5 @@ ALL_ADAPTERS = [
     MkDocsAdapter,
     Code2LlmAdapter,
     OrgReadmeAdapter,
+    IndexHtmlAdapter,
 ]

{code2docs-3.0.20 → code2docs-3.0.21}/code2docs.egg-info/PKG-INFO

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

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