Feature uml diagram

.github/workflows/uml.yml

@@ -0,0 +1,58 @@
+name: UML Diagram
+
+on:
+  push:
+    branches:
+      - master
+      - main
+      - copybara_push
+    paths:
+      - "smart_control/**/*.py"
+      - "Makefile"
+      - "pyproject.toml"
+      - "poetry.lock"
+      - ".github/workflows/uml.yml"
+
+  pull_request:
+    branches:
+      - master
+      - main
+      - copybara_push
+    paths:
+      - "smart_control/**/*.py"
+      - "Makefile"
+      - "pyproject.toml"
+      - "poetry.lock"
+      - ".github/workflows/uml.yml"
+
+permissions:
+  contents: read
+
+jobs:
+  uml:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install Poetry
+        run: pip install poetry==2.1.2
+
+      - name: Install dependencies
+        run: poetry install --with dev,docs
+
+      - name: Generate UML diagram
+        run: poetry run make uml
+
+      - name: Check generated diagram
+        run: |
+          if ! git diff --exit-code docs/images/class_diagram.svg; then
+            echo "::error::The UML diagram is outdated. Please run 'poetry run make uml' and commit the updated SVG."
+            exit 1
+          fi

Makefile

@@ -53,3 +53,14 @@ docs-quiet:
 
 docs-build:
 	poetry run mkdocs build
+
+#
+# UML Diagram
+#
+
+uml:
+	@echo "--- Generating UML class diagram ---"
+	pyreverse -o mmd -k -p smart_control smart_control/
+	sed -i '/^classDiagram/a\    direction LR' classes_smart_control.mmd
+	mermaidx -i classes_smart_control.mmd -o docs/images/class_diagram.svg
+	# rm -f classes_smart_control.mmd packages_smart_control.mmd