scripts/doc_generation¶
scripts.doc_generation.__init__¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | No module description available. |
| Args | — |
| Returns | — |
scripts.doc_generation.coverage_doc_generation¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | Split-by-Folder Coverage Documentation Generator |
| =============================================== | |
| Creates one Markdown file per folder: | |
| - ai.md, core.md, etc. | |
| Also generates: | |
| - index.md with folder links | |
| Args | — |
| Returns | — |
🛠️ Functions¶
generate_split_coverage_docs¶
Generate split coverage documentation files. Parameters: ['coverage_data: dict', 'output_dir: Path'] Returns: Any
main¶
No description available. Returns: Any
scripts.doc_generation.doc_renderers¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | Documentation Rendering Module |
| ============================= | |
| Contains rendering functions for coverage, code quality, and docstring reports. | |
| Separates presentation logic from data processing. | |
| Args | — |
| Returns | — |
🛠️ Functions¶
render_folder_coverage¶
Renders the markdown content for a single folder's coverage. Parameters: ['folder: str', 'entries: list'] Returns: str
render_coverage_index¶
Renders the index file for coverage reports. Parameters: ['folders: List[str]', 'totals: Dict[str, Any]'] Returns: List[str]
render_folder_report¶
Renders the markdown content for a single folder's code quality. Parameters: ['folder: str', 'section: dict', 'verbose: bool'] Returns: str
render_quality_index¶
Renders the index file for code quality reports. Parameters: ['folders: List[str]'] Returns: List[str]
render_module_docs¶
Renders the markdown content for a single module's docstrings. Unified format: header + summary table. Parameters: ['file_path: str', 'docstrings: Dict[str, Any]'] Returns: str
render_docstring_index¶
Renders the index file for docstring documentation. Parameters: ['sections: List[Tuple[str, List[Tuple[str, str]]]]'] Returns: List[str]
scripts.doc_generation.docstring_doc_generation¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | Split-by-Module Docstring Documentation Generator |
| ================================================ | |
| Creates markdown documentation files from docstring analysis: | |
| - One file per module/package | |
| - Generated MkDocs-compatible output structure | |
| - Index files with navigation links | |
| Args | — |
| Returns | — |
🛠️ Functions¶
generate_split_docstring_docs¶
Generate folder-grouped Markdown documentation from docstring data. Each top-level folder becomes a single .md file. Parameters: ['docstring_data: Dict[str, Dict[str, Any]]', 'output_dir: Path'] Returns: Any
main¶
No description available. Returns: Any
scripts.doc_generation.quality_doc_generation¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | Split-by-Folder Code Quality Markdown Generator |
| =============================================== | |
| Creates one Markdown file per top-level folder: | |
| - ai.md, core.md, etc. | |
| Each file includes: | |
| - Missing documentation | |
| - Linting issues | |
| - Optional: MyPy errors (--verbose) | |
| Args | — |
| Returns | — |
🛠️ Functions¶
generate_split_reports¶
Generate split code quality documentation files. Parameters: ['report_data: dict', 'output_dir: Path', 'verbose: bool'] Returns: Any
main¶
No description available. Returns: Any