Support explicit ordering of sphinx galleries #1504
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
This PR was inspired by the recent PR #1495. This PR make the following changes:
CustomSphinxGallerySectionSortKey
to allow explicit ordering of galleries for any sections while still providing the default alphabetical sort for any galleries that are not explicitly listed.How to test the behavior?
Build the docs
Checklist
flake8
from the source directory.