Source: factory.report/package.core/ObjReportDocumentation.py
Reusable documentation report base class.
Provides: sidebar navigation, collapsible panels,
section rendering, tables, code blocks, mermaid
diagrams, PDF export, and palette-driven CSS.
...
| Method | Signature | Description |
|---|---|---|
| render_section | render_section(title: str, icon: str, content: str, color: str = 'primary') -> str |
|
| render_table | render_table(headers, rows) -> str |
|
| render_code_block | render_code_block(content: str, lang: str = 'json') -> str |
|
| render_mermaid | render_mermaid(diagram: str) -> str |
|
| render_kv_grid | render_kv_grid(items: list[dict]) -> str |
|
| build_pages | build_pages(param1: str = '', param2: str = '', param3: str = '') -> list[dict] |
Return list of panel dicts for rendering. |
| get_title | get_title() -> str |
|
| get_subtitle | get_subtitle(param1: str = '', param2: str = '') -> str |
|
| Render | Render(param1: str = '', param2: str = '', param3: str = '', param4: str = '', param5: str = '', param6: str = '', param7: str = '', param8: str = '', param9: str = '') -> str |