docs: fix broken links surfaced by the weekly linkcheck cron

Open
#3,358 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with the weekly docs linkcheck run 27531921329 and inspect the listed links in user_guide/focal, user_guide/surface, user_guide/proximity, the xrspatial.proximity and xrspatial.multispectral.savi docstrings, and getting_started/why_xarray_spatial. Review conf.py for linkcheck_ignore and linkcheck_anchors_ignore entries, then check the landing-index targets and pharmacy-deserts.ipynb anchor. Done means the documented linkcheck failures are resolved or intentionally ignored and the weekly cron passes.

Written by the indexing model from the issue text.

Description

documentation

The weekly docs linkcheck cron (run 27531921329, 2026-06-15) is red with 7 problems. Most are external links that have rotted, a couple are anchor fragments linkcheck can't resolve, and the new landing index page reported some broken internal links. Listing them so the weekly cron can go green again.

External links that 404 or are blocked

Anchor fragments linkcheck can't resolve

  • xrspatial.proximity.euclidean_distance docstring (line 18): the Wikipedia Euclidean_distance link uses a #:~:text= text fragment
  • xrspatial.proximity.great_circle_distance docstring (line 23): same, on Great-circle_distance
  • getting_started/why_xarray_spatial (line 27): https://github.com/xarray-contrib/xarray-spatial#readme — anchor readme not found

Broken internal links from the new landing index (#3316)

These are internal targets, not external rot, so probably a separate fix:

  • user_guide/classification.html, user_guide/multispectral.html, user_guide/proximity.html, user_guide/surface.html
  • user_guide/surface.html#Hillshade, user_guide/surface.html#Slope
  • the examples/pharmacy-deserts.ipynb anchor "Create-a-Distance-to-Nearest-Pharmacy-Layer-&-Classify-into-5-Groups"

Notes

Linkcheck only runs on the Monday cron and on manual dispatch (not per-PR), and it's allowed to fail loudly, so it stays red until these are fixed. For the text-fragment and bot-blocked cases, a linkcheck_ignore / linkcheck_anchors_ignore entry in conf.py is probably the right fix rather than editing the URL.

Dominant language
Python
Stars
972
Forks
92
Avg merge
2d 12h
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from xarray-contrib/xarray-spatial

All issues in xarray-contrib/xarray-spatial

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.