docs: fix broken links surfaced by the weekly linkcheck cron
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
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
user_guide/focal(line 204): http://www.jennessent.com/downloads/tpi-poster-tnc_18x22.pdf — 404user_guide/surface(line 303): http://wenatcheeoutdoors.org/2016/04/07/avalanche-abcs-for-snowshoers/ — 404user_guide/proximity(line 682): https://pro.arcgis.com/en/pro-app/tool-reference/spatial-analyst/an-overview-of-the-distance-tools.htm — 404 (Esri moved these under doc.esri.com/en/arcgis-pro/...)user_guide/surface(line 895): https://pro.arcgis.com/en/pro-app/tool-reference/spatial-analyst/an-overview-of-the-surface-tools.htm — 404 (same Esri move)xrspatial.proximity.allocationdocstring (line 81): https://github.com/OSGeo/gdal/blob/master/gdal/alg/gdalproximity.cpp — 404 (GDAL repo restructured; the file lives at a different path now)xrspatial.multispectral.savidocstring (line 25): https://www.sciencedirect.com/science/article/abs/pii/003442578890106X — 403 (ScienceDirect blocks the checker; likely an ignore-list entry rather than a URL change)
Anchor fragments linkcheck can't resolve
xrspatial.proximity.euclidean_distancedocstring (line 18): the Wikipedia Euclidean_distance link uses a#:~:text=text fragmentxrspatial.proximity.great_circle_distancedocstring (line 23): same, on Great-circle_distancegetting_started/why_xarray_spatial(line 27): https://github.com/xarray-contrib/xarray-spatial#readme — anchorreadmenot 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.htmluser_guide/surface.html#Hillshade,user_guide/surface.html#Slope- the
examples/pharmacy-deserts.ipynbanchor "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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from xarray-contrib/xarray-spatial
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
xarray-contrib/xarray-spatial#3726 ·
-
api area:surface bug severity:medium sweep-api-consistency
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
xarray-contrib/xarray-spatial#3712 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
xarray-contrib/xarray-spatial#3710 ·
-
bug
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
xarray-contrib/xarray-spatial#3707 ·
-
area:surface documentation user-guide-example
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
xarray-contrib/xarray-spatial#3464 ·
All issues in xarray-contrib/xarray-spatial
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
zostera/django-bootstrap4#894 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3276 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
zephyrproject-rtos/zephyr#119726 ·
-
area/auth bug comp/agent P3 platform/discord type/security
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
NousResearch/hermes-agent#117848 ·