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

Pin sphinx_rtd_theme to < 3.0 for docs #3597

Merged
merged 3 commits into from
Nov 8, 2024
Merged

Pin sphinx_rtd_theme to < 3.0 for docs #3597

merged 3 commits into from
Nov 8, 2024

Conversation

yvonnefroehlich
Copy link
Member

@yvonnefroehlich yvonnefroehlich commented Nov 7, 2024

Description of proposed changes

See #3542 (comment) for context.

Fixes #3542

Preview: https://pygmt-dev--3597.org.readthedocs.build/en/3597

main branch this branch / PR
sphinx_rst_theme_main sphinx_rst_theme_thisbranch

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 command is:

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Nov 7, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Nov 7, 2024
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Nov 7, 2024
@seisman seisman changed the title POC: Pin "sphinx_rst_theme" to < 3.0 for docs Pin sphinx_rst_theme to < 3.0 for docs Nov 8, 2024
@seisman seisman merged commit b6f3e2b into main Nov 8, 2024
11 checks passed
@seisman seisman deleted the pin-sphinx-rst-theme branch November 8, 2024 08:27
@seisman seisman changed the title Pin sphinx_rst_theme to < 3.0 for docs Pin sphinx_rtd_theme to < 3.0 for docs Nov 8, 2024
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 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.

PyGMT website: Drop-down menu for selection version disappears for selection "dev"
2 participants