Skip to content

Do not show the 'Improve this page' button on sphinx-gallery execution time pages#2264

Merged
seisman merged 2 commits intomainfrom
doc-improve-this-page
Dec 22, 2022
Merged

Do not show the 'Improve this page' button on sphinx-gallery execution time pages#2264
seisman merged 2 commits intomainfrom
doc-improve-this-page

Conversation

@seisman
Copy link
Member

@seisman seisman commented Dec 21, 2022

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

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman added this to the 0.8.0 milestone Dec 21, 2022
@seisman seisman added the maintenance Boring but important stuff for the core devs label Dec 21, 2022
@seisman
Copy link
Member Author

seisman commented Dec 21, 2022

Now the "Improve this page" button disappear on these pages. See an example preview at
https://pygmt-dev--2264.org.readthedocs.build/en/2264/gallery/histograms/sg_execution_times.html

@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 21, 2022
65 tasks
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 22, 2022
@seisman seisman merged commit b3dcc68 into main Dec 22, 2022
@seisman seisman deleted the doc-improve-this-page branch December 22, 2022 11:27
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 22, 2022
@weiji14 weiji14 added the skip-changelog Skip adding Pull Request to changelog label Dec 29, 2022
seisman added a commit that referenced this pull request Jan 2, 2023
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 skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link Checker Report on 2022-12-18

4 participants