Link Checker Report on 2022-10-09

[github-actions[bot]]

Summary

Status	Count
🔍 Total	22598
✅ Successful	5688
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	16907
❓ Unknown	0
🚫 Errors	3

Errors per input

Errors in documentation/dev/api/generated/pygmt.Figure.ternary.html

• https://pygmt.org/latest/api/generated/pygmt.Figure.ternary.html: Failed: Network error (status code: 404)

Errors in documentation/dev/_modules/pygmt/src/ternary.html

• https://pygmt.org/latest/_modules/pygmt/src/ternary.html: Failed: Network error (status code: 404)

Errors in documentation/dev/gallery/symbols/bars.html

• https://pygmt.org/latest/gallery/symbols/bars.html: Failed: Network error (status code: 404)

Full Github Actions output

[maxrjones]

As an explanation for these failures, https://github.com/GenericMappingTools/pygmt/pull/1859 set the canonical url to point to the latest version. For any pages added since the last release, the link checker will fail on that url.

Options include closing these issues weekly if they only flag recently added pages or exclude links with the format https://pygmt.org/latest/* from the action.

[seisman]

As an explanation for these failures, #1859 set the canonical url to point to the latest version. For any pages added since the last release, the link checker will fail on that url.

Thanks for finding the cause.

closing these issues weekly if they only flag recently added pages

It sounds a bad option because these issues are annoying and we really can't remember exactly which pages are newly added.

exclude links with the format https://pygmt.org/latest/* from the action.

It should work but it makes me worry about potential side-effects.

Another solution is to have a "dynamic" htmt_baseurl based on the PyGMT version, similar to what we're doing at https://github.com/GenericMappingTools/pygmt/blob/211e03fc79932517b2ca22a562bbaabaa7bc54d1/doc/conf.py#L138-L141

if len(__version__.split("+")) > 1 or __version__ == "unknown":
    html_baseurl = "https://pygmt.org/dev/"
else:
    html_baseurl = "https://pygmt.org/latest/"

[maxrjones]

Another solution is to have a "dynamic" htmt_baseurl based on the PyGMT version, similar to what we're doing at

https://github.com/GenericMappingTools/pygmt/blob/211e03fc79932517b2ca22a562bbaabaa7bc54d1/doc/conf.py#L138-L141

if len(__version__.split("+")) > 1 or __version__ == "unknown":
    html_baseurl = "https://pygmt.org/dev/"
else:
    html_baseurl = "https://pygmt.org/latest/"

This seems like a good idea