Do not show the 'Improve this page' button on sphinx-gallery execution time pages#2264
Merged
Do not show the 'Improve this page' button on sphinx-gallery execution time pages#2264
Conversation
Member
Author
|
Now the "Improve this page" button disappear on these pages. See an example preview at |
maxrjones
approved these changes
Dec 21, 2022
michaelgrund
approved these changes
Dec 22, 2022
seisman
added a commit
that referenced
this pull request
Jan 2, 2023
7 tasks
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.
Description of proposed changes
Sphinx-gallery generates summary pages for script execution times, e.g., https://www.pygmt.org/dev/gallery/histograms/sg_execution_times.html. The "Improve this page" button makes no sense on these pages, and results in broken links (e.g., #2255).
This PR fixes the issue by disable the "Improve this page" button on these pages.
Fixes #2255.
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version