Skip to content

Do not show the 'Improve this page' button on the genindex page#2277

Merged
seisman merged 2 commits intomainfrom
fix-breadcrumbs
Dec 26, 2022
Merged

Do not show the 'Improve this page' button on the genindex page#2277
seisman merged 2 commits intomainfrom
fix-breadcrumbs

Conversation

@seisman
Copy link
Member

@seisman seisman commented Dec 26, 2022

Description of proposed changes

Fixes the broken link to https://github.com/GenericMappingTools/pygmt/edit/main/doc/genindex.

Addresses #2271.

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 the maintenance Boring but important stuff for the core devs label Dec 26, 2022
@seisman seisman added this to the 0.8.0 milestone Dec 26, 2022
@seisman seisman changed the title Do not show the 'Improve this page' button on the genindex page WIP: Do not show the 'Improve this page' button on the genindex page Dec 26, 2022
@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 26, 2022
65 tasks
@seisman seisman changed the title WIP: Do not show the 'Improve this page' button on the genindex page Do not show the 'Improve this page' button on the genindex page Dec 26, 2022
@seisman
Copy link
Member Author

seisman commented Dec 26, 2022

The "Improve the page" button no longer appears on the genindex pages (see https://pygmt-dev--2277.org.readthedocs.build/en/2277/genindex.html).

@michaelgrund michaelgrund added the final review call This PR requires final review and approval from a second reviewer label Dec 26, 2022
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 26, 2022
@seisman seisman merged commit a2c28d1 into main Dec 26, 2022
@seisman seisman deleted the fix-breadcrumbs branch December 26, 2022 15:03
@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.

3 participants