Skip to content

Commit 89c3bba

Browse files
refactor(tests): code analysis engine
changes: - file: test_cli.py area: cli added: [TestCLINewFeaturesE2E, temp_org, TestCLIShellE2E, temp_project, _run_shell] new_tests: 10 modified: [TestCLI] testing: new_tests: 10 scenarios: - shell_org_mode_dry_run - shell_diff - shell_version - shell_init - shell_check - shell_generate_with_sections - shell_org_mode - shell_generate - shell_generate_creates_files - shell_help stats: lines: "+9974/-9909 (net +65)" files: 13 complexity: "Large structural change (normalized)"
1 parent ffd0359 commit 89c3bba

21 files changed

+10003
-9914
lines changed

CHANGELOG.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## [3.0.7] - 2026-03-08
11+
12+
### Docs
13+
- Update project/context.md
14+
15+
### Test
16+
- Update tests/project/dashboard.html
17+
- Update tests/project/project.toon
18+
- Update tests/project/project.yaml
19+
- Update tests/test_cli.py
20+
21+
### Other
22+
- Update project/analysis.json
23+
- Update project/analysis.toon
24+
- Update project/analysis.yaml
25+
- Update project/calls.mmd
26+
- Update project/dashboard.html
27+
- Update project/flow.mmd
28+
- Update project/flow.toon
29+
- Update project/map.toon
30+
- Update project/project.toon
31+
- Update project/project.yaml
32+
- ... and 1 more files
33+
1034
## [3.0.6] - 2026-03-08
1135

1236
### Docs

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# code2docs
22

3-
![version](https://img.shields.io/badge/version-3.0.6-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
3+
![version](https://img.shields.io/badge/version-3.0.7-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
44

55
> Auto-generate and sync project documentation from source code analysis.
66
@@ -140,7 +140,7 @@ code2docs can update only specific sections of an existing README using markers:
140140
```markdown
141141
<!-- code2docs:start --># code2docs
142142

143-
![version](https://img.shields.io/badge/version-3.0.6-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)
143+
![version](https://img.shields.io/badge/version-3.0.7-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)
144144
> **276** functions | **57** classes | **51** files | CC̄ = 3.8
145145

146146
> Auto-generated project documentation from source code analysis.

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.0.6
1+
3.0.7

code2docs/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
README.md, API references, module docs, examples, and architecture diagrams.
66
"""
77

8-
__version__ = "3.0.6"
8+
__version__ = "3.0.7"
99
__author__ = "Tom Sapletta"
1010

1111
from .config import Code2DocsConfig

project/analysis.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

project/analysis.toon

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -165,10 +165,10 @@ CLASSES:
165165
SyncConfig 0m CC̄=0.0 max=0.0
166166
Code2LlmConfig 0m CC̄=0.0 max=0.0
167167
ApiChange 0m CC̄=0.0 max=0.0
168-
DocstringInfo 0m CC̄=0.0 max=0.0
169-
Endpoint 0m CC̄=0.0 max=0.0
170168
DependencyInfo 0m CC̄=0.0 max=0.0
171169
ProjectDependencies 0m CC̄=0.0 max=0.0
170+
Endpoint 0m CC̄=0.0 max=0.0
171+
DocstringInfo 0m CC̄=0.0 max=0.0
172172

173173
D:
174174
code2docs/generators/readme_gen.py:
@@ -280,15 +280,6 @@ Thi...
280280
e: ContributingGenerator
281281
ContributingGenerator # Generate CONTRIBUTING.md by detecting dev tools from pyproje...
282282
__init__(2) CC=1.0
283-
code2docs/analyzers/docstring_extractor.py:
284-
e: DocstringInfo,DocstringExtractor
285-
DocstringInfo # Parsed docstring with sections....
286-
DocstringExtractor # Extract and parse docstrings from AnalysisResult....
287-
extract_all(1) CC=5.0
288-
→ parse(1) CC=2.0
289-
→ _extract_summary(0) CC=2.0
290-
→ _parse_sections(2) CC=8.0
291-
→ _classify_section(0) CC=5.0
292283
code2docs/analyzers/dependency_scanner.py:
293284
e: DependencyInfo,ProjectDependencies,DependencyScanner
294285
DependencyInfo # Information about a project dependency....
@@ -301,6 +292,15 @@ Thi...
301292
→ _parse_dep_string(0) CC=2.0
302293
→ _parse_setup_py(1) CC=4.0
303294
→ _parse_requirements_txt(1) CC=5.0
295+
code2docs/analyzers/docstring_extractor.py:
296+
e: DocstringInfo,DocstringExtractor
297+
DocstringInfo # Parsed docstring with sections....
298+
DocstringExtractor # Extract and parse docstrings from AnalysisResult....
299+
extract_all(1) CC=5.0
300+
→ parse(1) CC=2.0
301+
→ _extract_summary(0) CC=2.0
302+
→ _parse_sections(2) CC=8.0
303+
→ _classify_section(0) CC=5.0
304304
code2docs/llm_helper.py:
305305
e: LLMHelper,_get_litellm
306306
LLMHelper # Thin wrapper around litellm for documentation generation.
@@ -426,19 +426,19 @@ Generators register t...
426426
e: run_cli_basic,run_cli_with_config
427427
run_cli_basic(project_path)
428428
run_cli_with_config(project_path,config_path)
429+
examples/02_configuration.py:
430+
e: create_basic_config,create_advanced_config,save_yaml_config_example,load_config_from_yaml
431+
create_basic_config()
432+
create_advanced_config()
433+
save_yaml_config_example(path)
434+
load_config_from_yaml(path)
429435
code2docs/base.py:
430436
e: GenerateContext,BaseGenerator
431437
GenerateContext # Shared context passed to all generators during a run....
432438
BaseGenerator # Abstract base for all documentation generators.
433439

434440
Subclasses ...
435441
__init__(2) CC=1.0
436-
examples/02_configuration.py:
437-
e: create_basic_config,create_advanced_config,save_yaml_config_example,load_config_from_yaml
438-
create_basic_config()
439-
create_advanced_config()
440-
save_yaml_config_example(path)
441-
load_config_from_yaml(path)
442442
code2docs/__main__.py:
443443
examples/quickstart.py:
444444
examples/advanced_usage.py:

0 commit comments

Comments
 (0)