Skip to content

Commit 270215d

Browse files
tom-sapletta-comtom-sapletta-com
committed
refactor(docs): code analysis engine
stats: lines: "+10262/-58369 (net -48107)" files: 17 complexity: "Stable complexity"
1 parent cd0b911 commit 270215d

33 files changed

+10292
-58374
lines changed

‎CHANGELOG.md‎

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

88
## [Unreleased]
99

10+
## [3.0.19] - 2026-03-09
11+
12+
### Docs
13+
- Update docs/README.md
14+
- Update docs/api-changelog.md
15+
- Update docs/architecture.md
16+
- Update project/context.md
17+
18+
### Test
19+
- Update tests/project/dashboard.html
20+
- Update tests/project/project.yaml
21+
22+
### Other
23+
- Update code2docs/project/analysis.json
24+
- Update code2docs/project/analysis.toon
25+
- Update code2docs/project/analysis.yaml
26+
- Update code2docs/project/calls.mmd
27+
- Update code2docs/project/dashboard.html
28+
- Update code2docs/project/evolution.toon
29+
- Update code2docs/project/flow.mmd
30+
- Update code2docs/project/flow.toon
31+
- Update code2docs/project/map.toon
32+
- Update code2docs/project/project.yaml
33+
- ... and 12 more files
34+
1035
## [3.0.18] - 2026-03-09
1136

1237
### 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.18-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.19-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.18-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.19-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.18
1+
3.0.19

‎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.18"
8+
__version__ = "3.0.19"
99
__author__ = "Tom Sapletta"
1010

1111
from .config import Code2DocsConfig

‎code2docs/project/analysis.json‎

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

‎code2docs/project/analysis.toon‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ FUNCTIONS (CC≥10, 27 of 255):
105105
10.0 ApiReferenceGenerator._has_content 6n 3exit cond+ret
106106
10.0 ApiChangelogGenerator._diff_functions 9n 1exit loops+cond
107107
10.0 ApiChangelogGenerator._diff_classes 15n 1exit loops+cond
108-
10.0 Code2DocsConfig.from_yaml 20n 3exit cond+ret
109108
10.0 _run_check 11n 1exit loops+cond
109+
10.0 Code2DocsConfig.from_yaml 20n 3exit cond+ret
110110

111111
summary:
112112
critical(≥10): 27 | high(5-10): 58 | medium(2-5): 100 | low(<2): 70
@@ -130,8 +130,8 @@ CLASSES:
130130
MarkdownFormatter ██████████████████ 13m CC̄=1.2 max=4
131131
OrgReadmeGenerator ██████████████ 10m CC̄=5.2 max=17 !!
132132
ArchitectureGenerator ██████████████ 10m CC̄=6.9 max=13
133-
DocstringExtractor ██████████████ 10m CC̄=3.5 max=8
134133
DependencyScanner ██████████████ 10m CC̄=6.0 max=9
134+
DocstringExtractor ██████████████ 10m CC̄=3.5 max=8
135135
DepGraphGenerator ████████████ 9m CC̄=3.9 max=9
136136
ModuleDocsGenerator ████████████ 9m CC̄=8.0 max=25 !!
137137
ApiChangelogGenerator ████████████ 9m CC̄=5.4 max=14
@@ -149,8 +149,8 @@ CLASSES:
149149
Code2LlmGenerator █████ 4m CC̄=6.2 max=17 !!
150150
Code2DocsConfig █████ 4m CC̄=4.0 max=10
151151
BaseGenerator ████ 3m CC̄=1.0 max=1
152-
EndpointDetector ████ 3m CC̄=4.0 max=5
153152
ProjectScanner ████ 3m CC̄=1.3 max=2
153+
EndpointDetector ████ 3m CC̄=4.0 max=5
154154
Updater ██ 2m CC̄=3.0 max=4
155155
ReadmeGeneratorAdapter ██ 2m CC̄=2.5 max=4
156156
ApiReferenceAdapter ██ 2m CC̄=2.0 max=2
@@ -167,20 +167,20 @@ CLASSES:
167167
Code2LlmAdapter ██ 2m CC̄=4.0 max=7
168168
OrgReadmeAdapter ██ 2m CC̄=3.0 max=4
169169
ChangeInfo █ 1m CC̄=1.0 max=1
170-
LLMConfig █ 1m CC̄=1.0 max=1
171170
DefaultGroup █ 1m CC̄=4.0 max=4
172-
ChangelogEntry 0m CC̄=0.0 max=0.0
171+
LLMConfig █ 1m CC̄=1.0 max=1
173172
GenerateContext 0m CC̄=0.0 max=0.0
173+
ChangelogEntry 0m CC̄=0.0 max=0.0
174174
ApiChange 0m CC̄=0.0 max=0.0
175175
ReadmeConfig 0m CC̄=0.0 max=0.0
176176
DocsConfig 0m CC̄=0.0 max=0.0
177177
ExamplesConfig 0m CC̄=0.0 max=0.0
178178
SyncConfig 0m CC̄=0.0 max=0.0
179179
Code2LlmConfig 0m CC̄=0.0 max=0.0
180-
Endpoint 0m CC̄=0.0 max=0.0
181-
DocstringInfo 0m CC̄=0.0 max=0.0
182180
DependencyInfo 0m CC̄=0.0 max=0.0
183181
ProjectDependencies 0m CC̄=0.0 max=0.0
182+
DocstringInfo 0m CC̄=0.0 max=0.0
183+
Endpoint 0m CC̄=0.0 max=0.0
184184

185185
D:
186186
generators/readme_gen.py:
@@ -242,18 +242,6 @@ Thi...
242242
e: ConfigDocsGenerator
243243
ConfigDocsGenerator # Generate docs/configuration.md from Code2DocsConfig dataclas...
244244
__init__(2) CC=1.0
245-
config.py:
246-
e: ReadmeConfig,DocsConfig,ExamplesConfig,SyncConfig,Code2LlmConfig,LLMConfig,Code2DocsConfig
247-
ReadmeConfig # Configuration for README generation....
248-
DocsConfig # Configuration for docs/ generation....
249-
ExamplesConfig # Configuration for examples/ generation....
250-
SyncConfig # Configuration for synchronization....
251-
Code2LlmConfig # Configuration for code2llm analysis generation....
252-
LLMConfig # Configuration for optional LLM-assisted documentation genera...
253-
from_env(0) CC=1.0
254-
Code2DocsConfig # Main configuration for code2docs....
255-
__post_init__(0) CC=2.0
256-
→ _detect_repo_url(-1) CC=3.0
257245
cli.py:
258246
e: DefaultGroup,main,generate,sync,watch,init,check,diff,_load_config,_run_generate,_run_sync,_run_watch,_run_check,_run_diff
259247
DefaultGroup # Click Group that routes unknown subcommands to 'generate'....
@@ -272,6 +260,18 @@ Thi...
272260
_run_watch(project_path,config)
273261
_run_check(project_path,config,target)
274262
_run_diff(project_path,config)
263+
config.py:
264+
e: ReadmeConfig,DocsConfig,ExamplesConfig,SyncConfig,Code2LlmConfig,LLMConfig,Code2DocsConfig
265+
ReadmeConfig # Configuration for README generation....
266+
DocsConfig # Configuration for docs/ generation....
267+
ExamplesConfig # Configuration for examples/ generation....
268+
SyncConfig # Configuration for synchronization....
269+
Code2LlmConfig # Configuration for code2llm analysis generation....
270+
LLMConfig # Configuration for optional LLM-assisted documentation genera...
271+
from_env(0) CC=1.0
272+
Code2DocsConfig # Main configuration for code2docs....
273+
__post_init__(0) CC=2.0
274+
→ _detect_repo_url(-1) CC=3.0
275275
generators/depgraph_gen.py:
276276
e: DepGraphGenerator
277277
DepGraphGenerator # Generate docs/dependency-graph.md with Mermaid diagrams....

0 commit comments

Comments
 (0)