docs: statically render mermaid diagrams to avoid pop-in

Fixes apache#976.
lidavidm · Sep 6, 2023 · 67e36bb · 67e36bb
1 parent 2d27f17
commit 67e36bb
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -126,6 +126,9 @@ used as follows:
 ```shell
 $ conda create -n adbc -c conda-forge --file ci/conda_env_docs.txt
 $ conda activate adbc
+# Mermaid must be installed separately
+# While "global", it will end up in your Conda environment
+$ npm install -g @mermaid-js/mermaid-cli
 ```
 
 To build the HTML documentation:

diff --git a/ci/conda_env_docs.txt b/ci/conda_env_docs.txt
@@ -20,6 +20,8 @@ doxygen
 # XXX(https://github.com/apache/arrow-adbc/issues/987)
 furo=2023.07.26
 make
+# Needed to install mermaid
+nodejs
 numpydoc
 pytest
 sphinx>=5.0

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -110,7 +110,9 @@
 
 # -- Options for mermaid -----------------------------------------------------
 
-mermaid_d3_zoom = True
+mermaid_d3_zoom = False
+# Prerender images to avoid page jumping on load
+mermaid_output_format = "png"
 
 # -- Options for numpydoc ----------------------------------------------------