Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update sphinx-gallery settings to support version >=0.11 #1733

Merged
merged 2 commits into from
Jul 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [#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)
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
2 changes: 1 addition & 1 deletion requirements-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down