Arkasha/archdoc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

feat: improve documentation quality with real data

Browse Source 
- Extract file-level docstrings from Python files (module-level string expressions)
- Use __init__.py docstrings as module doc_summary
- Use file docstrings as file purpose in layout tables (instead of 'Source file')
- Populate module outbound_modules/inbound_modules from import edges (internal only)
- Make filename sanitization consistent (sanitize_for_link matches sanitize_filename)
- Clean up stale .md files from previous runs before generating
- Fill ARCHITECTURE.md template with real layout, modules index, and critical points
- Add file_docstring field to ParsedModule and file_purpose to FileDoc
This commit is contained in:
Arkasha
2026-02-15 04:10:20 +03:00
parent 25fdf400fa
commit c095560e13
24 changed files with 936 additions and 518 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
test-project/ARCHITECTURE.md
View File

@@ -16,7 +16,7 @@
## Document metadata
- **Created:** 2026-01-25
- **Updated:** 2026-01-25
- **Updated:** 2026-02-15
- **Generated by:** archdoc (cli) v0.1
---
@@ -34,9 +34,9 @@ No tooling information available.
| Path | Purpose | Link |
|------|---------|------|
| ./src/__init__.py | Source file | [details](docs/architecture/files/._src___init__.py.md) |
| ./src/utils.py | Source file | [details](docs/architecture/files/._src_utils.py.md) |
| ./src/core.py | Source file | [details](docs/architecture/files/._src_core.py.md) |
| ./src/__init__.py | Test project package. | [details](docs/architecture/files/src____init__.py.md) |
| ./src/utils.py | Utility functions for the test project. | [details](docs/architecture/files/src__utils.py.md) |
| ./src/core.py | Core module with database and HTTP integrations. | [details](docs/architecture/files/src__core.py.md) |
<!-- ARCHDOC:END section=layout -->
---
@@ -46,9 +46,9 @@ No tooling information available.
| Module | Symbols | Inbound | Outbound | Link |
|--------|---------|---------|----------|------|
| ./src/__init__.py | 0 | 0 | 0 | [details](docs/architecture/modules/._src___init__.py.md) |
| ./src/utils.py | 4 | 0 | 0 | [details](docs/architecture/modules/._src_utils.py.md) |
| ./src/core.py | 6 | 0 | 0 | [details](docs/architecture/modules/._src_core.py.md) |
| core | 6 | 0 | 0 | [details](docs/architecture/modules/core.md) |
| utils | 4 | 0 | 0 | [details](docs/architecture/modules/utils.md) |
| src | 0 | 0 | 0 | [details](docs/architecture/modules/src.md) |
<!-- ARCHDOC:END section=modules_index -->
---