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

doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and require Sphinx-Gallery>=0.17.0 #3348

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

seisman
Copy link
Member

@seisman seisman commented Jul 21, 2024

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/

@seisman seisman changed the title POC: doc: Rename sphinx-gallery's README to GALLERY_HEADER Bump to Sphinx-Gallery>=0.17.0 and rename sphinx-gallery's README to GALLERY_HEADER Jul 27, 2024
@seisman seisman changed the title Bump to Sphinx-Gallery>=0.17.0 and rename sphinx-gallery's README to GALLERY_HEADER doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and requires Sphinx-Gallery>=0.17.0 Sep 10, 2024
@seisman seisman added the maintenance Boring but important stuff for the core devs label Sep 10, 2024
@seisman seisman added this to the 0.14.0 milestone Sep 10, 2024
@seisman seisman added the needs review This PR has higher priority and needs review. label Sep 10, 2024
@seisman seisman marked this pull request as ready for review September 10, 2024 02:13
@seisman
Copy link
Member Author

seisman commented Sep 10, 2024

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.

@weiji14 weiji14 changed the title doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and requires Sphinx-Gallery>=0.17.0 doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and require Sphinx-Gallery>=0.17.0 Sep 10, 2024
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so we're already using sphinx-gallery>=0.17.0 after #3356, and the renaming to GALLERY_HEADER.rst is just a nice-to-have (README.txt is still backwards compatible)? Looks good to me.

@seisman seisman merged commit 7133fec into main Sep 10, 2024
12 of 13 checks passed
@seisman seisman deleted the sphinx-gallery branch September 10, 2024 05:54
@seisman seisman removed the needs review This PR has higher priority and needs review. label Sep 10, 2024
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