autogenerated cpp uml diagrams

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>

Author: mgovers

.clang-uml

@@ -0,0 +1,67 @@
+compilation_database_dir: ./cpp_build/clang-debug
+output_directory: output/diagrams
+plantuml:
+  cmd: "plantuml -tsvg \"docs/diagrams/{}.puml\""
+diagrams:
+  power_grid_model_c_packages:
+    title: Power Grid Model C++ Packages
+    type: package
+    generate_packages: true
+    package_type: directory
+    glob:
+      - power_grid_model_c/**/*.cpp
+      - tests/native_api_tests/*.cpp
+      - tests/cpp_validation_tests/*.cpp
+
+  PowerGridModel:
+    title: Power Grid Model C++ Classes
+    type: class
+    glob:
+      - power_grid_model_c/**/model.cpp
+    using_namespace: power_grid_model
+    exclude:
+      namespaces:
+        - power_grid_model::detail
+        - power_grid_model::math_model_impl
+        - power_grid_model::meta_data::detail
+        - power_grid_model::statistics::detail
+        - power_grid_model::main_core::detail
+        - power_grid_model::main_core::update::detail
+        - power_grid_model::math_solver::detail
+        - power_grid_model::optimizer::detail
+        - std
+        - Eigen
+        - eigen
+      relationships:
+        - dependency
+      subclasses:
+        - clanguml::common::model::filter_visitor
+      access: [public, protected, private]
+      element_types:
+        - enum
+
+  core_include_diagram:
+    title: Power Grid Model C++ Core Include Diagram
+    type: include
+    glob:
+      - power_grid_model_c/**/*.cpp
+    relative_to: .
+    include:
+      paths:
+        - power_grid_model_c/**/*.cpp
+        - power_grid_model_c/**/*.hpp
+        - power_grid_model_c/**/*.h
+
+  integration_tests_include_diagram:
+    title: Power Grid Model C++ Native API/Validation Tests Include Diagram
+    type: include
+    glob:
+      - tests/native_api_tests/*.cpp
+      - tests/cpp_validation_tests/*.cpp
+    relative_to: .
+    include:
+      paths:
+        - tests/**/*.cpp
+        - tests/**/*.hpp
+        - power_grid_model_c/**/*.hpp
+        - power_grid_model_c/**/*.h

.readthedocs.yaml

@@ -14,6 +14,9 @@ build:
     python: "3.11"
   apt_packages:
     - graphviz
+    - plantuml
+    - cmake
+    - llvm
   jobs:
     post_install:
       # Build package with doc requirements from pyproject.optional-dependencies
@@ -23,7 +26,11 @@ build:
       - find power_grid_model_c/power_grid_model_c/include -name *.h -exec sed -i -r "s/PGM_API //g" {} \;
       # build doxygen for C header
       - cd docs/doxygen && doxygen && cd ../..
-      # build class and package diagrams
+      # build class and package diagrams for C++
+      - cmake --preset ci-clang-debug  # this generates the compilation database
+      - clang-uml --render_diagrams --compile-database cpp_build/ci-clang-debug --output_directory docs/_static
+      - rm docs/static/*.puml
+      # build class and package diagrams for Python
       - pyreverse --no-standalone -o dot src/power_grid_model
       - ccomps -x classes.dot | dot -Grankdir=LR -Nfontsize=13 -Efontsize=13 | gvpack -m100 -array_l1 | neato -n2 -Tsvg -o docs/_static/classes.svg
       - dot packages.dot -Grankdir=TD -Nfontsize=13 -Efontsize=13 -Tsvg -o docs/_static/packages.svg

docs/advanced_documentation/core-design.md

@@ -48,3 +48,37 @@ graph TD
 
     ComponentsOutput -->|Output| Output(Output data)
 ```
+
+## Class diagram
+
+```{raw} html
+<div style="overflow-x: auto; white-space: nowrap;">
+  <img src="../_static/PowerGridModel.svg" style="max-width: none;" alt="Power Grid Model C++ Classes">
+</div>.
+```
+
+## Package diagram
+
+```{raw} html
+<div style="overflow-x: auto; white-space: nowrap;">
+  <img src="../_static/power_grid_model_c_packages.svg" style="max-width: none;">
+</div>.
+```
+
+## Include paths
+
+### Core
+
+```{raw} html
+<div style="overflow-x: auto; white-space: nowrap;">
+  <img src="../_static/core_include_diagram.svg" style="max-width: none;">
+</div>.
+```
+
+### Tests
+
+```{raw} html
+<div style="overflow-x: auto; white-space: nowrap;">
+  <img src="../_static/integration_tests_include_diagram.svg" style="max-width: none;">
+</div>.
+```