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

Use substitutions to show the minimum required Python and GMT versions dynamically in installation guides #2488

Merged
merged 4 commits into from
Apr 20, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Apr 9, 2023

Description of proposed changes

Use sphinx's substitutions feature (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#substitutions) to insert the minimum required Python and GMT versions. The version strings are obtained from the PyGMT package dynamically so that we don't have to manually update the doc/install.rst file.

Preview: https://pygmt-dev--2488.org.readthedocs.build/en/2488/install.html

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

doc/conf.py Outdated Show resolved Hide resolved
@seisman seisman force-pushed the dynamic-version-string-in-docs branch from 002f624 to bae080c Compare April 9, 2023 06:08
@seisman seisman changed the title POC: Use substitutions to show the minimum required Python and GMT versions dynamically in installation guides Use substitutions to show the minimum required Python and GMT versions dynamically in installation guides Apr 17, 2023
@seisman seisman added maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. labels Apr 17, 2023
@seisman seisman added this to the 0.10.0 milestone Apr 17, 2023
@seisman seisman marked this pull request as ready for review April 17, 2023 07:19
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Apr 17, 2023
@seisman
Copy link
Member Author

seisman commented Apr 18, 2023

Ping @GenericMappingTools/pygmt-maintainers for one more reviewer for this PR.

@seisman seisman merged commit a46572b into main Apr 20, 2023
@seisman seisman deleted the dynamic-version-string-in-docs branch April 20, 2023 14:28
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 20, 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants