Fix version of sphinx gallery to fix gallery index (#1728)

* Fix version of sphinx gallery to fix gallery index * Update changelog
NeurodataWithoutBorders · Jul 20, 2023 · 529e92c · 529e92c
1 parent 0dbdf60
commit 529e92c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,8 @@
   [#1694](https://github.com/NeurodataWithoutBorders/pynwb/pull/1694)
 - Fixed test battery to show and check for warnings appropriately. @rly
   [#1698](https://github.com/NeurodataWithoutBorders/pynwb/pull/1698)
+- Fixed version of sphinx-gallery to 0.10.1 to avoid broken galley index in the docs. @oruebel
+  [#1728](https://github.com/NeurodataWithoutBorders/pynwb/pull/1728)
 
 ## PyNWB 2.3.2 (April 10, 2023)
 

diff --git a/requirements-doc.txt b/requirements-doc.txt
@@ -3,7 +3,7 @@
 sphinx>=4  # improved support for docutils>=0.17
 sphinx_rtd_theme>=1  # <1 does not work with docutils>=0.17
 matplotlib
-sphinx-gallery
+sphinx-gallery==0.10.1 # See issue 1726. Gallery index is broken for 0.11 - 0.13. TODO relax version once issue is fixed
 # allensdk>=2.13.2  # allensdk reinstalls pynwb and hdmf. TODO set up a separate workflow to test allensdk
 # MarkupSafe==2.0.1  # resolve incompatibility between jinja2 and markupsafe: https://github.com/AllenInstitute/AllenSDK/issues/2308
 Pillow