Skip to content

Consistent URL links when reference images in the GMT documentationΒ #4298

@seisman

Description

@seisman

Sometimes we need to reference images or documentation in the GMT documentation. Usually, we use the gmt-docs directive, but sometimes we can't and must use full URLs.

The URLs are inconsistently pointing to 6.5, 5.6, latest, and dev:

pygmt/encodings.py:19:- GMT documentation: https://docs.generic-mapping-tools.org/dev/reference/octal-codes.html
pygmt/tests/test_text.py:297:    https://docs.generic-mapping-tools.org/latest/gallery/ex23.html
pygmt/src/nearneighbor.py:65:    .. figure:: https://docs.generic-mapping-tools.org/dev/_images/GMT_nearneighbor.png
pygmt/params/position.py:21:    .. figure:: https://docs.generic-mapping-tools.org/dev/_images/GMT_anchor.png
pygmt/params/pattern.py:29:    .. figure:: https://docs.generic-mapping-tools.org/6.5/_images/GMT_App_E.png
examples/projections/cyl/cyl_universal_transverse_mercator.py:17:.. figure:: https://docs.generic-mapping-tools.org/latest/_images/GMT_utm_zones.png

I think we should use a consistent URL. I prefer to use a specific version (e.g., 6.6), so that any changes in the GMT documentation won't break our documentation suddenly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    maintenanceBoring but important stuff for the core devs

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions