add sphinx gallery

Tractables · Feb 15, 2024 · 2465d27 · 2465d27
1 parent cc8e976
commit 2465d27
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -28,7 +28,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser
+          pip install sphinx sphinx_rtd_theme myst_parser sphinx-gallery
 
       - name: Install PyJuice
         run: |

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,8 +17,14 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'sphinx_gallery.gen_gallery'
 ]
 
+sphinx_gallery_conf = {
+    # other configuration options
+    'gallery_dirs': 'getting-started/tutorials/generated/gallery',
+}
+
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3/', None),
     'sphinx': ('https://www.sphinx-doc.org/en/master/', None),