Skip to content

Commit be393c7

Browse files
tom-sapletta-comtom-sapletta-com
committed
refactor(docs): code analysis engine
stats: lines: "+99/-99 (net +0)" files: 9 complexity: "Stable complexity"
1 parent 39fed35 commit be393c7

File tree

14 files changed

+120
-105
lines changed

14 files changed

+120
-105
lines changed

‎CHANGELOG.md‎

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

128128
## [Unreleased]
129129

130+
## [3.0.24] - 2026-03-31
131+
132+
### Docs
133+
- Update project/README.md
134+
- Update project/context.md
135+
136+
### Other
137+
- Update project/analysis.toon.yaml
138+
- Update project/calls.mmd
139+
- Update project/compact_flow.mmd
140+
- Update project/index.html
141+
- Update project/map.toon.yaml
142+
- Update project/project.toon.yaml
143+
- Update project/prompt.txt
144+
130145
## [3.0.23] - 2026-03-31
131146

132147
### Docs

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## AI Cost Tracking
55

6-
![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.23-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
6+
![PyPI](https://img.shields.io/badge/pypi-costs-blue) ![Version](https://img.shields.io/badge/version-3.0.24-blue) ![Python](https://img.shields.io/badge/python-3.9+-blue) ![License](https://img.shields.io/badge/license-Apache--2.0-green)
77
![AI Cost](https://img.shields.io/badge/AI%20Cost-$7.50-orange) ![Human Time](https://img.shields.io/badge/Human%20Time-16.2h-blue) ![Model](https://img.shields.io/badge/Model-openrouter%2Fqwen%2Fqwen3--coder--next-lightgrey)
88

99
- 🤖 **LLM usage:** $7.5000 (52 commits)
@@ -15,7 +15,7 @@ Generated on 2026-03-31 using [openrouter/qwen/qwen3-coder-next](https://openrou
1515

1616

1717

18-
![version](https://img.shields.io/badge/version-3.0.23-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
18+
![version](https://img.shields.io/badge/version-3.0.24-blue) ![python](https://img.shields.io/badge/python-%3E%3D3.9-blue) ![docs](https://img.shields.io/badge/docs-auto--generated-blueviolet)
1919

2020
> Auto-generate and sync project documentation from source code analysis.
2121
@@ -155,7 +155,7 @@ code2docs can update only specific sections of an existing README using markers:
155155
```markdown
156156
<!-- code2docs:start --># code2docs
157157

158-
![version](https://img.shields.io/badge/version-3.0.23-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)
158+
![version](https://img.shields.io/badge/version-3.0.24-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)
159159
> **276** functions | **57** classes | **51** files | CC̄ = 3.8
160160

161161
> 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.23
1+
3.0.24

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

1111
from .config import Code2DocsConfig

‎project/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,6 +335,6 @@ code2llm ./ -f yaml --separate-orphans
335335
**Analysis Date**: 2026-03-31
336336
**Total Functions**: 298
337337
**Total Classes**: 60
338-
**Modules**: 54
338+
**Modules**: 55
339339

340340
For more information about code2llm, visit: https://github.com/tom-sapletta/code2llm

‎project/analysis.toon.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# code2llm | 39f 5810L | python:38,shell:1 | 2026-03-31
1+
# code2llm | 39f 5811L | python:38,shell:1 | 2026-03-31
22
# CC̄=4.4 | critical:12/298 | dups:0 | cycles:1
33

44
HEALTH[12]:
@@ -10,8 +10,8 @@ HEALTH[12]:
1010
🟡 CC generate CC=18 (limit:15)
1111
🟡 CC _render_module_detail CC=25 (limit:15)
1212
🟡 CC _extract_description CC=17 (limit:15)
13-
🟡 CC _generate_advanced CC=22 (limit:15)
1413
🟡 CC _render_module_section CC=25 (limit:15)
14+
🟡 CC _generate_advanced CC=22 (limit:15)
1515
🟡 CC _generate_html CC=15 (limit:15)
1616
🟡 CC _render_code_style CC=16 (limit:15)
1717

@@ -34,7 +34,7 @@ PIPELINES[247]:
3434
LAYERS:
3535
code2docs/ CC̄=4.4 ←in:0 →out:1
3636
│ !! readme_gen 477L 1C 18m CC=29 ←1
37-
│ !! examples_gen 443L 1C 15m CC=22 ←0
37+
│ !! examples_gen 444L 1C 15m CC=22 ←0
3838
│ !! _registry_adapters 441L 15C 31m CC=15 ←0
3939
│ dependency_scanner 325L 3C 10m CC=9 ←0
4040
│ cli 319L 1C 14m CC=10 ←0

‎project/calls.mmd‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,31 +3,31 @@ flowchart LR
33
code2docs__analyzers__project_scanner__ProjectScanner__analyze["analyze"]
44
end
55
subgraph code2docs__cli
6-
code2docs__cli__diff["diff"]
7-
code2docs__cli__sync["sync"]
86
code2docs__cli__watch["watch"]
97
code2docs__cli___run_watch["_run_watch"]
10-
code2docs__cli___load_config["_load_config"]
8+
code2docs__cli__check["check"]
9+
code2docs__cli___run_sync["_run_sync"]
10+
code2docs__cli__sync["sync"]
1111
code2docs__cli___run_diff["_run_diff"]
12+
code2docs__cli__diff["diff"]
1213
code2docs__cli___run_check["_run_check"]
13-
code2docs__cli___run_sync["_run_sync"]
14-
code2docs__cli__check["check"]
14+
code2docs__cli___load_config["_load_config"]
1515
end
1616
subgraph code2docs__config
1717
code2docs__config__Code2DocsConfig__from_yaml["from_yaml"]
1818
end
1919
subgraph code2docs__formatters
2020
code2docs__formatters__badges___make_badge["_make_badge"]
21+
code2docs__formatters__toc__extract_headings["extract_headings"]
2122
code2docs__formatters__toc__generate_toc["generate_toc"]
2223
code2docs__formatters__toc___slugify["_slugify"]
23-
code2docs__formatters__toc__extract_headings["extract_headings"]
2424
code2docs__formatters__badges__generate_badges["generate_badges"]
2525
end
2626
subgraph code2docs__generators
27-
code2docs__generators__code2llm_gen__Code2LlmGenerator___run_code2llm["_run_code2llm"]
27+
code2docs__generators__readme_gen__ReadmeGenerator___build_context["_build_context"]
2828
code2docs__generators__readme_gen__generate_readme["generate_readme"]
2929
code2docs__generators__code2llm_gen__parse_gitignore["parse_gitignore"]
30-
code2docs__generators__readme_gen__ReadmeGenerator___build_context["_build_context"]
30+
code2docs__generators__code2llm_gen__Code2LlmGenerator___run_code2llm["_run_code2llm"]
3131
end
3232
subgraph code2docs__llm_helper
3333
code2docs__llm_helper___get_litellm["_get_litellm"]
@@ -40,10 +40,10 @@ flowchart LR
4040
examples__02_configuration__load_config_from_yaml["load_config_from_yaml"]
4141
end
4242
subgraph examples__03_programmatic_api
43+
examples__03_programmatic_api__generate_docs_if_needed["generate_docs_if_needed"]
4344
examples__03_programmatic_api__generate_full_documentation["generate_full_documentation"]
44-
examples__03_programmatic_api__inspect_project_structure["inspect_project_structure"]
4545
examples__03_programmatic_api__custom_documentation_pipeline["custom_documentation_pipeline"]
46-
examples__03_programmatic_api__generate_docs_if_needed["generate_docs_if_needed"]
46+
examples__03_programmatic_api__inspect_project_structure["inspect_project_structure"]
4747
examples__03_programmatic_api__generate_readme_simple["generate_readme_simple"]
4848
end
4949
subgraph examples__04_sync_and_watch
@@ -59,14 +59,15 @@ flowchart LR
5959
end
6060
subgraph examples__07_web_frameworks
6161
examples__07_web_frameworks__detect_flask_endpoints["detect_flask_endpoints"]
62-
examples__07_web_frameworks__generate_api_docs_from_endpoints["generate_api_docs_from_endpoin"]
6362
examples__07_web_frameworks__detect_fastapi_endpoints["detect_fastapi_endpoints"]
6463
examples__07_web_frameworks__document_web_project["document_web_project"]
64+
examples__07_web_frameworks__generate_api_docs_from_endpoints["generate_api_docs_from_endpoin"]
6565
end
6666
code2docs__formatters__badges__generate_badges --> code2docs__formatters__badges___make_badge
6767
code2docs__formatters__toc__generate_toc --> code2docs__formatters__toc__extract_headings
6868
code2docs__formatters__toc__extract_headings --> code2docs__formatters__toc___slugify
6969
code2docs__generators__readme_gen__ReadmeGenerator___build_context --> code2docs__formatters__badges__generate_badges
70+
code2docs__generators__code2llm_gen__Code2LlmGenerator___run_code2llm --> code2docs__generators__code2llm_gen__parse_gitignore
7071
code2docs__cli__sync --> code2docs__cli___load_config
7172
code2docs__cli__sync --> code2docs__cli___run_sync
7273
code2docs__cli__watch --> code2docs__cli___load_config
@@ -77,23 +78,22 @@ flowchart LR
7778
code2docs__cli__diff --> code2docs__cli___run_diff
7879
code2docs__cli___load_config --> code2docs__config__Code2DocsConfig__from_yaml
7980
code2docs__cli___run_watch --> code2docs__sync__watcher__start_watcher
80-
code2docs__generators__code2llm_gen__Code2LlmGenerator___run_code2llm --> code2docs__generators__code2llm_gen__parse_gitignore
8181
examples__04_sync_and_watch__watch_and_auto_regenerate --> code2docs__sync__watcher__start_watcher
8282
examples__05_custom_generators__generate_custom_report --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
8383
examples__06_formatters__badge_examples --> code2docs__formatters__badges__generate_badges
8484
examples__06_formatters__toc_examples --> code2docs__formatters__toc__generate_toc
8585
examples__06_formatters__toc_examples --> code2docs__formatters__toc__extract_headings
8686
examples__06_formatters__build_custom_readme --> code2docs__formatters__toc__generate_toc
87-
examples__03_programmatic_api__generate_readme_simple --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
88-
examples__03_programmatic_api__generate_readme_simple --> code2docs__generators__readme_gen__generate_readme
89-
examples__03_programmatic_api__generate_full_documentation --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
90-
examples__03_programmatic_api__custom_documentation_pipeline --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
91-
examples__03_programmatic_api__inspect_project_structure --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
92-
examples__03_programmatic_api__generate_docs_if_needed --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
9387
examples__07_web_frameworks__detect_flask_endpoints --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
9488
examples__07_web_frameworks__detect_fastapi_endpoints --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
9589
examples__07_web_frameworks__generate_api_docs_from_endpoints --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
9690
examples__07_web_frameworks__document_web_project --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
9791
examples__07_web_frameworks__document_web_project --> examples__07_web_frameworks__generate_api_docs_from_endpoints
9892
examples__02_configuration__load_config_from_yaml --> code2docs__config__Code2DocsConfig__from_yaml
93+
examples__03_programmatic_api__generate_readme_simple --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
94+
examples__03_programmatic_api__generate_readme_simple --> code2docs__generators__readme_gen__generate_readme
95+
examples__03_programmatic_api__generate_full_documentation --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
96+
examples__03_programmatic_api__custom_documentation_pipeline --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
97+
examples__03_programmatic_api__inspect_project_structure --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
98+
examples__03_programmatic_api__generate_docs_if_needed --> code2docs__analyzers__project_scanner__ProjectScanner__analyze
9999
code2docs__llm_helper__LLMHelper__complete --> code2docs__llm_helper___get_litellm

‎project/compact_flow.mmd‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ flowchart TD
1919
code2docs__cli -->|1| code2docs__sync
2020
examples__04_sync_and_watch -->|1| code2docs__sync
2121
examples__05_custom_generators -->|1| code2docs__analyzers
22-
examples__03_programmatic_api -->|1| code2docs__generators
2322
examples__02_configuration -->|1| code2docs__config
23+
examples__03_programmatic_api -->|1| code2docs__generators

0 commit comments

Comments
 (0)