Add a diagram for parts.rst

canonical · Apr 28, 2023 · 95d83d6 · 95d83d6
1 parent 80dc1cc
commit 95d83d6
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -51,6 +51,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.viewcode",
     "sphinx_autodoc_typehints",  # must be loaded after napoleon
+    "sphinx-mermaid",
     "sphinx-pydantic",
     "sphinx_design",
     "sphinxcontrib.details.directive",

diff --git a/docs/explanation/parts.rst b/docs/explanation/parts.rst
@@ -31,6 +31,31 @@ describe a build process typically accept specifications of parts in YAML format
 mostly-declarative format. Libraries that use parts may use the underlying
 data structures to describe them.
 
+.. mermaid ::
+
+    graph LR
+
+    project
+    cache
+    style cache stroke-dasharray: 5 5
+
+    subgraph parts["part(s)"]
+    src
+    build
+    install
+    end
+
+    stage
+    prime
+
+    project -->|pull| cache
+    cache -->|overlay| src
+    src -->|build| build
+    build -->|organize| install
+    install -->|stage| stage
+    stage -->|prime| prime
+
+
 Describing a part
 -----------------
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -7,6 +7,7 @@ Sphinx==5.3.0
 sphinx-autobuild==2021.3.14
 sphinx-autodoc-typehints==1.20.0
 sphinx-jsonschema==1.19.1
+sphinx-mermaid==0.0.8
 sphinx-pydantic==0.1.1
 sphinxcontrib-applehelp==1.0.2
 sphinx_design==0.3.0