Docs: use linkcheck build to verify external links
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 150
- Fork
- 23
- Merge trung bình
- 1 ngày 11 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
As part of our release process we manually test links e.g. to the relevant sections in the CF conventions. This check can be largely automated (all but fixing incorrect links) by running the sphinx.builders.linkcheck builder which detects broken links and raises warnings if they are found.
Addressing this will help towards automation of the release process (see #134).
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Không có tệp hoặc bài kiểm thử nào được nêu. Hãy bắt đầu bằng cách xác định cấu hình build tài liệu Sphinx và các tham chiếu đến quy trình release, sau đó xem lại tài liệu về builder linkcheck. Công việc được hoàn tất khi build tài liệu release kiểm tra các liên kết bên ngoài và báo cáo các liên kết bị hỏng dưới dạng cảnh báo mà không yêu cầu kiểm thử liên kết thủ công.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation, release
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100