code2docs 3.0.2__tar.gz → 3.0.4__tar.gz

{code2docs-3.0.2 → code2docs-3.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code2docs
-Version: 3.0.2
+Version: 3.0.4
 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.2-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.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.
 
@@ -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.2-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.4-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.2 → code2docs-3.0.4}/README.md

@@ -1,6 +1,6 @@
 # code2docs
 
-![version](https://img.shields.io/badge/version-3.0.2-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.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.
 
@@ -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.2-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.4-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.2 → code2docs-3.0.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__ = "3.0.2"
+__version__ = "3.0.4"
 __author__ = "Tom Sapletta"
 
 from .config import Code2DocsConfig

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs/analyzers/dependency_scanner.py

@@ -32,6 +32,11 @@ class ProjectDependencies:
     optional_groups: Dict[str, List[DependencyInfo]] = field(default_factory=dict)
     install_command: str = "pip install ."
     source_file: str = ""
+    # Additional metadata from pyproject.toml
+    keywords: List[str] = field(default_factory=list)
+    classifiers: List[str] = field(default_factory=list)
+    urls: Dict[str, str] = field(default_factory=dict)
+    version: str = ""
 
 
 class DependencyScanner:
@@ -76,6 +81,10 @@ class DependencyScanner:
 
         project = data.get("project", {})
         deps.python_version = project.get("requires-python", "")
+        deps.version = project.get("version", "")
+        deps.keywords = project.get("keywords", [])
+        deps.classifiers = project.get("classifiers", [])
+        deps.urls = project.get("urls", {})
 
         # Main dependencies
         for dep_str in project.get("dependencies", []):
@@ -96,6 +105,9 @@ class DependencyScanner:
         if name:
             deps.install_command = f"pip install {name}"
 
+        # Detect version with fallback to git tags or VERSION file
+        deps.version = self._detect_version(path.parent, deps.version)
+
         return deps
 
     def _parse_pyproject_regex(self, path: Path) -> ProjectDependencies:
@@ -157,3 +169,29 @@ class DependencyScanner:
                 version_spec=match.group(2).strip(),
             )
         return DependencyInfo(name=dep_str.strip())
+
+    def _detect_version(self, project_path: Path, pyproject_version: str = "") -> str:
+        """Detect version from pyproject.toml, git tags, or VERSION file."""
+        # Priority 1: pyproject.toml version
+        if pyproject_version:
+            return pyproject_version
+
+        # Priority 2: VERSION file
+        version_file = project_path / "VERSION"
+        if version_file.exists():
+            return version_file.read_text(encoding="utf-8").strip()
+
+        # Priority 3: git tags (latest tag)
+        try:
+            import subprocess
+            result = subprocess.run(
+                ["git", "describe", "--tags", "--abbrev=0"],
+                cwd=str(project_path),
+                capture_output=True, text=True, timeout=5,
+            )
+            if result.returncode == 0:
+                return result.stdout.strip().lstrip("v")
+        except (subprocess.TimeoutExpired, FileNotFoundError):
+            pass
+
+        return ""

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs/generators/_registry_adapters.py

@@ -25,7 +25,12 @@ class ReadmeGeneratorAdapter(BaseGenerator):
             preview = content[:500] + "..." if len(content) > 500 else content
             click.echo(preview)
             return None
-        readme_path = ctx.project / self.config.readme_output
+        # Use docs_dir if readme_output is a simple filename, otherwise respect the path
+        readme_output = Path(self.config.readme_output)
+        if readme_output.parent == Path("."):
+            readme_path = ctx.docs_dir / readme_output.name
+        else:
+            readme_path = ctx.project / readme_output
         gen.write(str(readme_path), content)
         return f"✅ {readme_path.relative_to(ctx.project)}"
 
@@ -141,7 +146,7 @@ class ExamplesAdapter(BaseGenerator):
         files = gen.generate_all()
         if ctx.dry_run:
             return f"[dry-run] examples/ ({len(files)} files)"
-        examples_dir = ctx.project / "examples"
+        examples_dir = ctx.docs_dir / "examples"
         gen.write_all(str(examples_dir), files)
         return f"✅ examples/ ({len(files)} files)"
 
@@ -158,7 +163,7 @@ class MkDocsAdapter(BaseGenerator):
         content = gen.generate(str(ctx.docs_dir))
         if ctx.dry_run:
             return "[dry-run] mkdocs.yml"
-        gen.write(str(ctx.project / "mkdocs.yml"), content)
+        gen.write(str(ctx.docs_dir / "mkdocs.yml"), content)
         return "✅ mkdocs.yml"
 
 
@@ -208,7 +213,8 @@ class ContributingAdapter(BaseGenerator):
         content = gen.generate()
         if ctx.dry_run:
             return "[dry-run] CONTRIBUTING.md"
-        (ctx.project / "CONTRIBUTING.md").write_text(content, encoding="utf-8")
+        ctx.docs_dir.mkdir(parents=True, exist_ok=True)
+        (ctx.docs_dir / "CONTRIBUTING.md").write_text(content, encoding="utf-8")
         return "✅ CONTRIBUTING.md"
 
 

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs/generators/contributing_gen.py

@@ -54,10 +54,11 @@ class ContributingGenerator:
     def _render_setup(self, tools: Dict[str, bool]) -> str:
         """Render development setup instructions."""
         project = self.config.project_name or "project"
+        repo_url = self.config.repo_url or "<repository-url>"
         lines = [
             "## Development Setup\n",
             "```bash",
-            f"git clone <repository-url>",
+            f"git clone {repo_url}",
             f"cd {project}",
             "python -m venv .venv",
             "source .venv/bin/activate  # or .venv\\Scripts\\activate on Windows",

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs/generators/examples_gen.py

@@ -59,6 +59,44 @@ class ExamplesGenerator:
         self.result = result
         self._pkg = self._detect_package_name()
 
+    def _get_example_value(self, arg_name: str) -> str:
+        """Get realistic example value based on actual project config."""
+        project_name = self.config.project_name or Path(self.result.project_path).name
+        
+        # Map argument names to actual config values
+        arg_mappings = {
+            "project_path": f'"./{project_name}"',
+            "path": f'"./{project_name}"',
+            "source": f'"{self.config.source}"' if self.config.source else '"./src"',
+            "output": f'"{self.config.output}"' if self.config.output else '"./docs"',
+            "output_dir": f'"{self.config.output}"' if self.config.output else '"./docs"',
+            "output_path": f'"{self.config.readme_output}"' if self.config.readme_output else '"./docs/README.md"',
+            "config": "config",
+            "config_path": '"code2docs.yaml"',
+            "result": "result",
+            "name": f'"{project_name}"',
+            "project_name": f'"{project_name}"',
+            "verbose": "True",
+            "dry_run": "False",
+            "readme_only": "False",
+            "sections": '["overview", "install", "quickstart"]',
+            "content": '"# My Doc\\n## Section"',
+            "markdown_content": '"# My Doc\\n## Section"',
+            "max_depth": "3",
+            "target": "80",
+            "badge_types": '["version", "python"]',
+            "stats": "{}",
+            "deps": "[]",
+            "sync_markers": "True",
+            "docstring": '"""My function docstring."""',
+        }
+        
+        if arg_name in arg_mappings:
+            return arg_mappings[arg_name]
+        
+        # Fallback to original static examples
+        return _ARG_EXAMPLES.get(arg_name, '"..."')
+
     def generate_all(self) -> Dict[str, str]:
         """Generate all example files. Returns {filename: content}."""
         files: Dict[str, str] = {}
@@ -100,15 +138,18 @@ class ExamplesGenerator:
 
         # --- Example 1: Config (define first so later examples can use it) ---
         config_cls = self._find_class_by_name("Code2DocsConfig")
+        project_name = self.config.project_name or Path(self.result.project_path).name
+        source = self.config.source or "./"
+        output = self.config.output or "./docs"
         if config_cls:
             lines.append('# ' + '=' * 50)
             lines.append("# Example 1: Configuration")
             lines.append('# ' + '=' * 50)
             lines.append("")
             lines.append(f"config = {config_cls.name}(")
-            lines.append('    project_name="my-project",')
-            lines.append('    source="./src",')
-            lines.append('    output="./docs",')
+            lines.append(f'    project_name="{project_name}",')
+            lines.append(f'    source="{source}",')
+            lines.append(f'    output="{output}",')
             lines.append("    verbose=True,")
             lines.append(")")
             lines.append("")
@@ -119,20 +160,22 @@ class ExamplesGenerator:
         lines.append("# Example 2: Generate documentation")
         lines.append('# ' + '=' * 50)
         lines.append("")
+        
+        project_path = f'"./{project_name}"' if project_name != "." else '"./"'
 
         gen_func = self._find_function_by_name("generate_readme")
         if gen_func:
             lines.append("# Generate a README for your project")
-            lines.append('generate_readme("./my-project", output="README.md")')
+            lines.append(f'generate_readme({project_path}, output="README.md")')
             lines.append("")
 
         docs_func = self._find_function_by_name("generate_docs")
         if docs_func:
             lines.append("# Generate all documentation")
             if config_cls:
-                lines.append('docs = generate_docs("./my-project", config=config)')
+                lines.append(f'docs = generate_docs({project_path}, config=config)')
             else:
-                lines.append('docs = generate_docs("./my-project")')
+                lines.append(f'docs = generate_docs({project_path})')
             lines.append('print(f"Generated {len(docs)} documentation sections")')
             lines.append("")
 
@@ -147,7 +190,7 @@ class ExamplesGenerator:
             lines.append(f"from {pkg}.analyzers.project_scanner import ProjectScanner")
             lines.append("")
             lines.append("scanner = ProjectScanner(config)")
-            lines.append('result = scanner.analyze("./my-project")')
+            lines.append(f'result = scanner.analyze({project_path})')
             lines.append("")
             lines.append('print(f"Found {len(result.functions)} functions")')
             lines.append('print(f"Found {len(result.classes)} classes")')
@@ -191,7 +234,7 @@ class ExamplesGenerator:
             lines.append("# Step 1: Analyze the project")
             lines.append("config = Code2DocsConfig(project_name=\"my-project\")")
             lines.append("scanner = ProjectScanner(config)")
-            lines.append('result = scanner.analyze("./my-project")')
+            lines.append('result = scanner.analyze(f"./${project_name_adv}") if project_name_adv != "." else result = scanner.analyze("./")')
             lines.append("")
 
             for i, cls in enumerate(gen_classes[:4], start=2):
@@ -351,8 +394,8 @@ class ExamplesGenerator:
         args = [a for a in func.args if a not in ("self", "cls")]
         parts = []
         for arg in args[:5]:
-            val = _ARG_EXAMPLES.get(arg)
-            if not val:
+            val = self._get_example_value(arg)
+            if not val or val == '"..."':
                 # Try type hint
                 val = self._example_from_type(func, arg)
             if not val:
@@ -360,17 +403,18 @@ class ExamplesGenerator:
             parts.append(f"{arg}={val}" if len(args) > 1 else val)
         return ", ".join(parts)
 
-    @staticmethod
-    def _example_from_type(func: FunctionInfo, arg: str) -> Optional[str]:
+    def _example_from_type(self, func: FunctionInfo, arg: str) -> Optional[str]:
         """Try to infer example value from type annotation."""
+        project_name = self.config.project_name or Path(self.result.project_path).name
+        
         # FunctionInfo.returns gives return type, but arg types
         # are not always available; use naming heuristics
         if "path" in arg.lower():
-            return '"./my-project"'
+            return f'"./{project_name}"'
         if "name" in arg.lower():
-            return '"my-project"'
+            return f'"{project_name}"'
         if "dir" in arg.lower():
-            return '"./docs"'
+            return f'"{self.config.output}"' if self.config.output else '"./docs"'
         if arg.startswith("is_") or arg.startswith("enable"):
             return "True"
         if "count" in arg.lower() or "max" in arg.lower() or "min" in arg.lower():

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs/generators/getting_started_gen.py

@@ -59,6 +59,7 @@ class GettingStartedGenerator:
         dep_scanner = DependencyScanner()
         deps = dep_scanner.scan(self.result.project_path)
         cmd = deps.install_command or f"pip install {self.config.project_name or '.'}"
+        repo_url = self.config.repo_url or "<repository-url>"
         lines = [
             "## Installation\n",
             "```bash",
@@ -66,7 +67,7 @@ class GettingStartedGenerator:
             "```\n",
             "To install from source:\n",
             "```bash",
-            "git clone <repository-url>",
+            f"git clone {repo_url}",
             f"cd {self.config.project_name or 'project'}",
             "pip install -e .",
             "```",

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs/generators/mkdocs_gen.py

@@ -1,7 +1,7 @@
 """MkDocs configuration generator — auto-generate mkdocs.yml from docs tree."""
 
 from pathlib import Path
-from typing import Dict, List, Optional
+from typing import Any, Dict, List, Optional
 
 import yaml
 
@@ -22,11 +22,14 @@ class MkDocsGenerator:
         project_name = self.config.project_name or "Project"
         nav = self._build_nav(docs_dir)
 
+        # Read MkDocs config from pyproject.toml if available
+        mkdocs_config = self._read_pyproject_mkdocs()
+
         data = {
             "site_name": f"{project_name} Documentation",
-            "theme": {"name": "material"},
+            "theme": mkdocs_config.get("theme", {"name": "material"}),
             "nav": nav,
-            "markdown_extensions": [
+            "markdown_extensions": mkdocs_config.get("markdown_extensions", [
                 "admonition",
                 "pymdownx.highlight",
                 "pymdownx.superfences",
@@ -37,10 +40,47 @@ class MkDocsGenerator:
                         "format": "!!python/name:pymdownx.superfences.fence_code_format",
                     }]
                 }},
-            ],
+            ]),
         }
+
+        # Add extra fields from pyproject.toml if present
+        for key in ["extra_css", "extra_javascript", "plugins", "copyright"]:
+            if key in mkdocs_config:
+                data[key] = mkdocs_config[key]
+
         return yaml.dump(data, default_flow_style=False, sort_keys=False)
 
+    def _read_pyproject_mkdocs(self) -> Dict[str, Any]:
+        """Read MkDocs configuration from [tool.mkdocs] in pyproject.toml."""
+        project_path = Path(self.result.project_path)
+        pyproject_path = project_path / "pyproject.toml"
+
+        if not pyproject_path.exists():
+            # Also check parent directory (for nested packages)
+            pyproject_path = project_path.parent / "pyproject.toml"
+
+        if not pyproject_path.exists():
+            return {}
+
+        try:
+            import tomllib
+            with open(pyproject_path, "rb") as f:
+                data = tomllib.load(f)
+
+            # Support both [tool.mkdocs] and [tool.poetry.plugins.mkdocs] formats
+            tool_data = data.get("tool", {})
+            mkdocs_data = tool_data.get("mkdocs", {})
+
+            # Also check for poetry-style config
+            if not mkdocs_data:
+                poetry = tool_data.get("poetry", {})
+                plugins = poetry.get("plugins", {})
+                mkdocs_data = plugins.get("mkdocs", {})
+
+            return mkdocs_data
+        except Exception:
+            return {}
+
     def _build_nav(self, docs_dir: Optional[str] = None) -> List:
         """Build navigation structure from docs tree and analysis."""
         nav: List = [{"Home": "index.md"}]

{code2docs-3.0.2 → code2docs-3.0.4}/code2docs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: code2docs
-Version: 3.0.2
+Version: 3.0.4
 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.2-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.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.
 
@@ -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.2-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.4-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.2 → code2docs-3.0.4}/pyproject.toml

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