Repository navigation
DOC: Add file-based listed gallery order for examples - #31714
Merged
Merged
Conversation
timhoffm
force-pushed
the
doc-gallery_order-txt
branch
from
May 19, 2026 23:02
93e57c8 to
2cdb5de
Compare
QuLogic
reviewed
Jun 4, 2026
This adds support for a file "gallery_order.txt" in gallery folders for specifying the display order or examples. Advantages compared to the previous order approach: - Orders are now defined inside each gallery and not in a central list - The placeholder '*' allows to put some examples at the front, some at the end, and all others alphabetically sorted in the position of the placeholder - Checking of entries that do no exist as examples - Checking that all examples are listed (if no placeholder is specified) Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
timhoffm
force-pushed
the
doc-gallery_order-txt
branch
from
June 4, 2026 09:09
5b55da7 to
bc2d2ed
Compare
QuLogic
approved these changes
Jun 4, 2026
3 of 4 tasks
timhoffm
pushed a commit
that referenced
this pull request
Jun 4, 2026
timhoffm
added a commit
that referenced
this pull request
Jun 4, 2026
…714-on-v3.11.x Backport PR #31714 on branch v3.11.x (DOC: Add file-based listed gallery order for examples)
story645
pushed a commit
that referenced
this pull request
Jun 5, 2026
Forgot to add this file in #31714. This maintains the order that has been there before.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR summary
This adds support for a file "gallery_order.txt" in gallery folders for specifying the display order or examples.
Advantages compared to the previous order approach:
AI Disclosure
No AI used