modify graph and update css

jessica-mitchell · Aug 15, 2023 · 9b5c34d · 9b5c34d
1 parent 09ea933
commit 9b5c34d
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 51 deletions.
diff --git a/...eveloper_space/workflows/documentation_workflow/user_documentation_workflow.rst b/...eveloper_space/workflows/documentation_workflow/user_documentation_workflow.rst
@@ -23,60 +23,53 @@ with each release of NEST having its own documentation.
 
 This workflow aims for the concept of **user-correctable documentation**.
 
-.. mermaid::
-   :zoom:
 
-   flowchart TB
-    subgraph build
-     html
-     pre-html-->html
-     subgraph pre-html
-      ai["auto_examples: ipynb"]
-      ar["auto_examples: rst"]
-      ap["auto_examples: py"]
-     end
-    end
-    subgraph sphinx
-     rst-->html
-     subgraph autodoc
-      api_docstrings-->html
-     end
-     subgraph gallery
-      py_examples-->ai
-      py_examples-->ar
-      py_examples-->ap
-     end
-     subgraph custom_extensions
-      extractor_userdocs.py-->html
-      button["add_button_to_examples: conf.py"]-->html
-     end
-    end
-    subgraph source_files
-     docs["doc/htmldoc: rst"]-->sphinx
-     models["models: h"]-->custom_extensions
-     py["pynest/examples"]-->gallery
-     api["pynest/nest"]-->autodoc
-    end
-    subgraph nest/nest-simulator-examples
-     Jupyter_notebook_pyexamples-->button
-    end
-
-
-|
 
 .. 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()
+   :zoom:
+   :caption: Overview of documentation build. Drag and zoom to explore.
+
+   flowchart LR
+
+      subgraph BUILD: Read the docs or _build/
+        subgraph output
+         html
+         arti
+        end
+        ar-->html
+        ap-->arti["artifacts (downloadable)"]
+        ai-->arti
+        subgraph sphinx
+         rst_parse-->html
+          subgraph autodoc
+           api_docstrings-->html
+          end
+         subgraph gallery
+          ai["auto_examples: ipynb"]
+          ar["auto_examples: rst"]
+          ap["auto_examples: py"]
+         end
+         subgraph custom_extensions
+          extractor_userdocs.py-->html
+          button["fn add_button_to_examples: conf.py"]-->html
+         end
+         subgraph nbsphinx
+          notebooks --> html
+         end
+        end
+      end
+
+      subgraph SOURCE: nest/nest-simulator
+       docs["doc/htmldoc: .rst"]-->sphinx
+       models["cpp models: .h"]-->extractor_userdocs.py
+       py["pynest/examples: .py"]-->gallery
+       api["pynest/nest .py"]-->autodoc
+       ipynb["model_details: .ipynb"]-->nbsphinx
+      end
+      subgraph nest/nest-simulator-examples
+       Jupyter_notebook_pyexamples-->button
+       ai -..-> Jupyter_notebook_pyexamples
+      end
 
 
 .. image:: ../../../static/img/documentation_workflow.png

diff --git a/doc/htmldoc/static/css/custom.css b/doc/htmldoc/static/css/custom.css
@@ -86,6 +86,26 @@ section#kernel-attributes dl.py.class dd dl.py.attribute dd dl.field-list.simple
   display: none;
 }
 
+/*************************************************************
+ * Rules for  mermaid diagrams
+ *************************************************************/
+
+.mermaid .cluster rect {
+	fill: #fff !important;
+	stroke: #0E6A93 !important;
+	stroke-width: 1px !important;
+}
+
+
+rect.basic.label-container {
+	fill: #e2e2e200; !important
+	stroke: #ff6633;
+	stroke-width: 1px;
+}
+
+figure, .align-default {
+	text-align: center;
+}
 /**************************************************************************************
  Settings for overriding material design theme 
  Setting nest colors to override sphinx material "orange" and other default colors