Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs: fix broken links surfaced by the weekly linkcheck cron

Đang mở
#3,358 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
65/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
975
Fork
93
Merge trung bình
1 giờ 15 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của xarray-contrib/xarray-spatial

Tất cả issue của xarray-contrib/xarray-spatial

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.