Use YAML frontmatter to configure Sankey diagram.

See: mgaitan/sphinxcontrib-mermaid#147
kdeldycke · Oct 21, 2024 · e2f2900 · e2f2900
1 parent d3627dd
commit e2f2900
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 212 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,19 +58,6 @@
 
 # Always use the latest version of Mermaid.
 mermaid_version = "latest"
-# XXX Force hiding of Sankey values globally while we wait for in-place front-matter
-# support: https://github.com/mgaitan/sphinxcontrib-mermaid/issues/147
-mermaid_init_js = """
-  const config = {
-    startOnLoad: true,
-    sankey: {
-      width: 800,
-      height: 400,
-      showValues: false,
-    },
-  };
-  mermaid.initialize(config);
-"""
 mermaid_d3_zoom = True
 
 master_doc = "index"

diff --git a/extra_platforms/docs_update.py b/extra_platforms/docs_update.py
@@ -83,6 +83,8 @@ def generate_platform_sankey() -> str:
         config:
           sankey:
             showValues: false
+            width: 800
+            height: 400
         ---
         sankey-beta\n
         """)

diff --git a/pyproject.toml b/pyproject.toml
@@ -50,7 +50,7 @@ docs = [
     # sphinx-design 0.5.0 is the first to allow Sphinx 7.
     "sphinx-design >= 0.5",
     "sphinx-issues ~= 4.1.0",
-    "sphinxcontrib-mermaid ~= 0.9.2",
+    "sphinxcontrib-mermaid ~= 1.0.0",
     "sphinxext-opengraph ~= 0.9.0",
     "tomli ~= 2.0.1 ; python_version < '3.11'",
 ]

diff --git a/readme.md b/readme.md
@@ -162,6 +162,8 @@ Relationships between groups and platforms:
 config:
   sankey:
     showValues: false
+    width: 800
+    height: 400
 ---
 sankey-beta