add mermaid charts

docs/conf.py

@@ -10,41 +10,40 @@
 # if we want that again some day, here were the docs in that sub-folder docs dir:
 #   https://github.com/sartography/spiff-arena/blob/d9b303db782b1004a818c426283e9cfbc5ed0ec7/spiffworkflow-backend/docs/conf.py
 
-project = 'SpiffWorkflow'
-copyright = '2023, Sartography'
-author = 'Sartography' # Very ok to add your name here.
-release = '0.1'
+project = "SpiffWorkflow"
+copyright = "2023, Sartography"
+author = "Sartography"  # Very ok to add your name here.
+release = "0.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['myst_parser']
-
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
+extensions = ["myst_parser", "sphinxcontrib.mermaid"]
 
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"]
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-#html_theme = 'alabaster'
+# html_theme = 'alabaster'
 html_theme = "sphinx_rtd_theme"
-html_static_path = ['static']
+html_static_path = ["static"]
 html_logo = "spiffworkflow_logo.png"
 
 html_theme_options = {
-    'logo_only': True,
-    'display_version': False,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
-    'vcs_pageview_mode': '',
+    "logo_only": True,
+    "display_version": False,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
+    "vcs_pageview_mode": "",
     # Toc options
-    'collapse_navigation': False,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": False,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 
 

docs/requirements.txt

@@ -44,6 +44,7 @@ sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
 sphinxcontrib-qthelp==1.0.7
 sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-mermaid==0.9.2
 tornado==6.4
 typeguard==4.2.1
 Unidecode==1.3.8