DOC: Update URLs (Link Checker Report on 2025-03-25)

[yvonnefroehlich]

Description of proposed changes

• Errors in documentation/dev/install.html

  • [402] https://xarray.dev/ | Error (cached)
    -> problem very likely on the Xarray side ("This deployment is temporarily paused")

• Errors in repository/doc/minversions.md

  • [404] https://github.com/GenericMappingTools/pygmt/releases/download/%7B%7Bpath%7D%7D/pygmt-docs.pdf | Network error: Not Found
  • [404] https://github.com/GenericMappingTools/pygmt/releases/download/%7B%7Bpath%7D%7D/pygmt-docs.zip | Network error: Not Found
    -> probably issue with "{" and "}" for using variables -> excluded

• Errors in documentation/dev/techref/environment_variables.html

  • [TIMEOUT] https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html | Timeout
    -> works for me and is loaded fast

• Errors in repository/README.md

  • [404] PyGMT: A Python interface for the Generic Mapping Tools pyOpenSci/software-submission#43 | Network error: Not Found
    -> updated

• Errors in repository/doc/install.md

  • [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/gallery/index.rst | Cannot find file
  • [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/tutorials/index.rst | Cannot find file
  • [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/intro/index.rst | Cannot find file
    -> using GALLERY_HEADER.rst does not work -> excluded see comment DOC: Update URLs (Link Checker Report on 2025-03-25) #3875 (comment)
  • [402] https://xarray.dev/ | Network error: Payment Required
    -> same as in the first bullet point; problem very likely on the Xarray side ("This deployment is temporarily paused")

• Errors in repository/doc/conf.py

  • [404] https://sphinx-gallery.readthedocs.io/en/latest/configuration.html | Network error: Not Found
    -> updated
  • [404] https://github.com/%7Brepository%7D | Network error: Not Found
    Full Github Actions output
    -> probably issue with "{" and "}" for using variables; double "{{" and "}}" do not help see above -> excluded

Fixes #3871

Previews:

• https://pygmt-dev--3875.org.readthedocs.build/en/3875/install.html#intro

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.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash command is:

• /format: automatically format and lint the code

[seisman]

• [404] https://github.com/GenericMappingTools/pygmt/releases/download/%7B%7Bpath%7D%7D/pygmt-docs.zip | Network error: Not Found
  -> probably issue with "{" and "}" for using variables

Yes, need to add these them to .github/workflows/check-links.yml.

[seisman]

• [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/gallery/index.rst | Cannot find file
• [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/tutorials/index.rst | Cannot find file
• [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/intro/index.rst | Cannot find file
  -> using GALLERY_HEADER.rst does not work

Maybe just remove this sentence?

Start by looking at our Intro, Tutorials, and Gallery.

[yvonnefroehlich]

• [404] https://github.com/GenericMappingTools/pygmt/releases/download/%7B%7Bpath%7D%7D/pygmt-docs.zip | Network error: Not Found
  -> probably issue with "{" and "}" for using variables

Yes, need to add these them to .github/workflows/check-links.yml.

Thanks!! I knew that we have a file with the excluded links, but could not find it...

[seisman]

• [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/gallery/index.rst | Cannot find file
• [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/tutorials/index.rst | Cannot find file
• [ERROR] file:///home/runner/work/pygmt/pygmt/repository/doc/intro/index.rst | Cannot find file
  -> using GALLERY_HEADER.rst does not work

Maybe just remove this sentence?

Start by looking at our Intro, Tutorials, and Gallery.

Wait. Maybe we should not check the .md files under the doc directory.