code2docs 3.0.3__tar.gz → 3.0.4__tar.gz

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

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

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

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

@@ -138,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("")
@@ -157,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("")
 
@@ -185,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")')
@@ -229,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):
@@ -389,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:
@@ -398,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.3 → code2docs-3.0.4}/code2docs.egg-info/PKG-INFO

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

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