Use extlinks for linking GMT docs, and get rid of gmt_module_docs decorator #294
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
In this PR, I use extlinks to insert links to GMT documentation, instead of the gmt_module_docs decorator.
will be rendered as https://www.generic-mapping-tools.org/gmt/latest/coast.html.
It's more flexible than the decorator and it can link to any GMT documentations. Thus, we can get rid of the gmt_module_docs decorator.
The only side-effect I know is that
help(pygmt.Figure.coast)
in interactive mode shows the raw RST string, rather then the link to GMT site.Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.