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 :gmt-docs: instead of full links #2682

Merged
merged 5 commits into from
Sep 14, 2023
Merged

Use :gmt-docs: instead of full links #2682

merged 5 commits into from
Sep 14, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 11, 2023

Description of proposed changes

Fixes #

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 marked this pull request as draft September 11, 2023 04:30
@seisman seisman marked this pull request as ready for review September 12, 2023 08:25
@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog labels Sep 12, 2023
@seisman seisman added this to the 0.11.0 milestone Sep 12, 2023
@seisman seisman added the needs review This PR has higher priority and needs review. label Sep 12, 2023
Copy link
Member

@yvonnefroehlich yvonnefroehlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Contributors Guide, in the section "Cross-referencing with Sphinx", we also should update the example link for the GMT configuration parameters from "latest" to "6.4":

An example would be using :gmt-docs:makecpt.html to link to https://docs.generic-mapping-tools.org/6.4/makecpt.html. For GMT configuration parameters, an example is :gmt-term:COLOR_FOREGROUND to link to https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND.

@seisman
Copy link
Member Author

seisman commented Sep 12, 2023

In the Contributors Guide, in the section "Cross-referencing with Sphinx", we also should update the example link for the GMT configuration parameters from "latest" to "6.4":

An example would be using :gmt-docs:makecpt.html to link to https://docs.generic-mapping-tools.org/6.4/makecpt.html. For GMT configuration parameters, an example is :gmt-term:COLOR_FOREGROUND to link to https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND.

Yes, I also saw this one. I'm a little hesitate to update "latest" to "6.4", because doing that means we also need to update it when we bump to GMT 6.5. Actually, I feel we should change

For GMT configuration parameters, an example is
<code>:gmt-term:\`COLOR_FOREGROUND\`</code> to link to
{gmt-term}`https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND <COLOR_FOREGROUND>`.

to

For GMT configuration parameters, an example is
<code>:gmt-term:\`COLOR_FOREGROUND\`</code> to link to
{gmt-term}`COLOR_FOREGROUND`.

@yvonnefroehlich
Copy link
Member

In the Contributors Guide, in the section "Cross-referencing with Sphinx", we also should update the example link for the GMT configuration parameters from "latest" to "6.4":

An example would be using :gmt-docs:makecpt.html to link to https://docs.generic-mapping-tools.org/6.4/makecpt.html. For GMT configuration parameters, an example is :gmt-term:COLOR_FOREGROUND to link to https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND.

Yes, I also saw this one. I'm a little hesitate to update "latest" to "6.4", because doing that means we also need to update it when we bump to GMT 6.5. Actually, I feel we should change

For GMT configuration parameters, an example is
<code>:gmt-term:\`COLOR_FOREGROUND\`</code> to link to
{gmt-term}`https://docs.generic-mapping-tools.org/latest/gmt.conf#term-COLOR_FOREGROUND <COLOR_FOREGROUND>`.

to

For GMT configuration parameters, an example is
<code>:gmt-term:\`COLOR_FOREGROUND\`</code> to link to
{gmt-term}`COLOR_FOREGROUND`.

Actually, your suggested change was my first idea of how to update it. But then I thought that it was maybe intended to show the complete link. However, I am fine with your suggestion, as it shows how the link finally appears in the documentation.

@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 Sep 12, 2023
@seisman seisman merged commit ecf9cf9 into main Sep 14, 2023
@seisman seisman deleted the use-gmt-docs branch September 14, 2023 00:27
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 14, 2023
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 skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants