Documentation Generator Tools and Diagram Tooling

1. Overview & Business Value#

This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Documentation Generator Tools and Diagram Tooling within SmartERP.

The smarterp_docs documentation engine provides automated tooling for compiling declarative JSON diagram specifications into dual-theme (Light + Dark) SVG and PNG visual assets.

Diagram Build Tooling#

# Verify all diagrams and check manifest integrity
python3 addons/smarterp_docs/tools/diagrams.py --check

# Compile JSON specifications into PNG assets
python3 addons/smarterp_docs/tools/diagrams.py --build

{screenshot:smarterp-docs-generator-and-tools-overview-dashboard}

2. Prerequisites & Security Access Groups#

• Required Modules: base, web, smarterp_core
• Security Groups:
  • Enterprise Developer (Technical ID: base.group_no_one)
  • System Administrator (Technical ID: base.group_system)
• Master Data Dependencies: Established local development toolchain (Python 3.12+, PostgreSQL 16), cloned repository (smarterp-platform), and valid database configuration.

3. Step-by-Step Configuration & Execution#

Step 1: Navigating to the Module Interface#

1. Open your terminal or development environment in the repository root (/Users/danielbekele/smarterp-platform).
2. Activate your dedicated Python virtual environment.
3. Verify Git branch status: git status.

{screenshot:smarterp-docs-generator-and-tools-app-switcher-navigation}

Step 2: Creating and Parameterizing Records#

1. Execute development commands or scaffolding templates.
2. Define mandatory manifest parameters:
   • name (Mandatory): Descriptive module title.
   • version (Mandatory): Standard semantic versioning (e.g. 19.0.1.0.0).
   • depends (Mandatory): Explicit list of upstream module dependencies.
   • license (Mandatory): Open source or proprietary enterprise license identifier.
3. Configure optional parameters: data files, security ACLs, and automated test cases.

{screenshot:smarterp-docs-generator-and-tools-record-creation-form}

Step 3: Validating and Processing Transactions#

• Execution & Testing: Run unit tests via odoo-bin -i <module_name> --test-enable --stop-after-init.
• Quality Verification: Ensure test suite passes with zero errors and zero unhandled warnings.

{screenshot:smarterp-docs-generator-and-tools-transaction-processing-state}

4. Advanced Configuration Points#

• Automated Actions & Scheduled Tasks (Crons):
  • Developer: Module test runner trigger (base.ir_cron_run_tests)
  • System: Automated cache cleanup (base.ir_cron_cache_cleanup)
• Custom Print Templates & Reports:
  • Technical Data Dictionary Specification
  • Code Quality & Test Coverage Dossier
• Multi-Company Rules: Record-level security isolation under Company 1 (Ashewa Technology Solutions S.C.).

5. Comprehensive Troubleshooting Matrix#