doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and require Sphinx-Gallery>=0.17.0#3348
Merged
doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and require Sphinx-Gallery>=0.17.0#3348
Conversation
2eafa9c to
af30707
Compare
Member
Author
|
This PR is ready for review. Since this PR requires sphinx-gallery>=0.17.0 which was released two months ago, I'm unsure if we should make the changes now or later. |
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
2 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.
See the upstream issue (sphinx-gallery/sphinx-gallery#1209) and PR (sphinx-gallery/sphinx-gallery#1321) for context.
This PR renames Sphinx-Gallery's README.txt files to GALLERY_HEADER.rst. It requires sphinx-gallery>=0.17.0 (released on 2024/07/21 https://github.com/sphinx-gallery/sphinx-gallery/releases/tag/v0.17.0).
v0.17.0 changelog: https://sphinx-gallery.github.io/stable/changes.html#v0-17-0.
Preview: https://pygmt-dev--3348.org.readthedocs.build/en/3348/