From 94c9341030d0cc9836233826065bf60caa1b0f42 Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Sun, 23 Jul 2023 01:45:53 -0700 Subject: [PATCH 1/2] Update sphinx-gallery settings to support version >=0.11 --- CHANGELOG.md | 3 +-- docs/source/conf.py | 1 + requirements-doc.txt | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a218c901b..02cb41e97 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,8 +7,7 @@ - Update links for making a release. @mavaylon1 [#1720](https://github.com/NeurodataWithoutBorders/pynwb/pull/1720) ### Bug fixes -- 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) +- Fixed sphinx-gallery setting to correctly display index in the docs with sphinx-gallery>=0.11. @oruebel [#1728](https://github.com/NeurodataWithoutBorders/pynwb/pull/1728) ### Documentation and tutorial enhancements - Added thumbnail for Optogentics tutorial @oruebel [#1729](https://github.com/NeurodataWithoutBorders/pynwb/pull/1729) diff --git a/docs/source/conf.py b/docs/source/conf.py index 3b21fe457..bc6741bbd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -134,6 +134,7 @@ def __call__(self, filename): 'min_reported_time': 5, 'remove_config_comments': True, 'within_subsection_order': CustomSphinxGallerySectionSortKey, + 'nested_sections': False, # See issue https://github.com/sphinx-gallery/sphinx-gallery/issues/1152 } intersphinx_mapping = { diff --git a/requirements-doc.txt b/requirements-doc.txt index 477bf8b89..e8594dd32 100644 --- 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==0.10.1 # See issue 1726. Gallery index is broken for 0.11 - 0.13. TODO relax version once issue is fixed +sphinx-gallery # 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 From 45a1bc7a96450226a46005c891b2b7507ce809d4 Mon Sep 17 00:00:00 2001 From: Oliver Ruebel Date: Sun, 23 Jul 2023 01:50:12 -0700 Subject: [PATCH 2/2] Update CHANGELOG --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02cb41e97..c6f72894f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ - Update links for making a release. @mavaylon1 [#1720](https://github.com/NeurodataWithoutBorders/pynwb/pull/1720) ### Bug fixes -- Fixed sphinx-gallery setting to correctly display index in the docs with sphinx-gallery>=0.11. @oruebel [#1728](https://github.com/NeurodataWithoutBorders/pynwb/pull/1728) +- Fixed sphinx-gallery setting to correctly display index in the docs with sphinx-gallery>=0.11. @oruebel [#1733](https://github.com/NeurodataWithoutBorders/pynwb/pull/1733) ### Documentation and tutorial enhancements - Added thumbnail for Optogentics tutorial @oruebel [#1729](https://github.com/NeurodataWithoutBorders/pynwb/pull/1729)