-
Notifications
You must be signed in to change notification settings - Fork 224
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
Conversation
There was a problem hiding this 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.
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
to
|
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. |
Description of proposed changes
Fixes #
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version