DOC: Rename gallery README.txt files to GALLERY_HEADER.rst#31399
Merged
QuLogic merged 1 commit intomatplotlib:mainfrom Mar 27, 2026
Merged
DOC: Rename gallery README.txt files to GALLERY_HEADER.rst#31399QuLogic merged 1 commit intomatplotlib:mainfrom
QuLogic merged 1 commit intomatplotlib:mainfrom
Conversation
f4e8e20 to
77bcb95
Compare
GALLERY_HEADER.rst is a more telling name and avoids confusion with regular READMEs. It's the name recommended by sphinx-gallery nowadays. For details see sphinx-gallery/sphinx-gallery#1209 Using GALLERY_HEADER.rst is supported since sphinx-gallery 0.17 (released Jul 2024),so we need to bump the sphinx-gallery version.
77bcb95 to
291b5cb
Compare
story645
approved these changes
Mar 27, 2026
QuLogic
approved these changes
Mar 27, 2026
Member
|
Docs build passed and the rest of the failures are fixed by #31401, but shouldn't be affected by this PR, so merging. |
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
3 participants
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.
GALLERY_HEADER.rst is a more telling name and avoids confusion with regular READMEs. It's the recommend name for sphinx-gallery nowadays. For details see
sphinx-gallery/sphinx-gallery#1209
Using GALLERY_HEADER.rst is supported since sphinx-gallery 0.17 (released Jul 2024), so we need to bump the sphinx-gallery version.