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

Bump to sphinx-gallery>=0.19 and use list in subsection_order and string in within_subsection_order #3805

Merged
merged 2 commits into from
Feb 15, 2025

Conversation

seisman
Copy link
Member

@seisman seisman commented Feb 13, 2025

Since sphinx-gallery v0.16, it's possible to use plain list for subsection_order and string names for within_subsection_order, so we don't have to run from sphinx_gallery.sorting import ExampleTitleSortKey, ExplicitOrder.

However, this feature has a bug that wasn't fixed until sphinx-gallery/sphinx-gallery#1391. So, this feature needs sphinx-gallery>=0.19.

xref:

Preview: https://pygmt-dev--3805.org.readthedocs.build/en/3805/index.html

@seisman seisman added maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. labels Feb 13, 2025
@seisman seisman added this to the 0.15.0 milestone Feb 13, 2025
@seisman seisman marked this pull request as ready for review February 13, 2025 14:18
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. final review call This PR requires final review and approval from a second reviewer labels Feb 14, 2025
@seisman seisman merged commit 8c270a2 into main Feb 15, 2025
12 of 13 checks passed
@seisman seisman deleted the doc/sphinx-gallery branch February 15, 2025 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants