Add sphinx-mermaid extension and update userdoc workflow

doc/htmldoc/conf.py

@@ -95,6 +95,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.mathjax',
     'nbsphinx',
+    'sphinxcontrib.mermaid',
     'sphinx_design',
     'HoverXTooltip',
     'VersionSyncRole',
@@ -103,6 +104,8 @@
 mathjax_path = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
 # "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
 # "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"  # noqa
+mermaid_output_format = "raw"
+mermaid_version = ""
 
 panels_add_bootstrap_css = False
 # Add any paths that contain templates here, relative to this directory.
@@ -253,6 +256,7 @@ def setup(app):
     app.add_css_file('css/custom.css')
     app.add_css_file('css/pygments.css')
     app.add_js_file("js/custom.js")
+    app.add_js_file("js/mermaid.js")
 
     # for events see
     # https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx-core-events

doc/htmldoc/developer_space/architecture/kernel.rst

@@ -0,0 +1,18 @@
+Kernel
+======
+
+.. mermaid::
+
+   sequenceDiagram
+      user -> simulation_manager: prepare()
+      simulation_manager -> node_manager: prepare_nodes()
+      node_manager -> node: init()
+      node_manager -> node: pre_run_hook()
+      Note left of node_manager: state:<br/>prepared
+      user -> simulation_manager: run()
+      Note right of simulation_manager: 1
+      user -> simulation_manager: run()
+      Note left of user: store results<br/>...
+      user -> simulation_manager: cleanup()
+
+

doc/requirements.txt

@@ -20,6 +20,7 @@ scipy
 seaborn
 sphinx>=4.0.2
 sphinx_autobuild
+sphinxcontrib-mermaid
 sphinx-design
 sphinx_gallery
 sphinx-material