Infra: errors blocking migration towards docutils 0.22+
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- reStructuredText
- Star
- 5k
- Fork
- 1.8k
- Merge trung bình
- 2 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 25
Mô tả
Following the work in #4087, I have decided to investigate possible issues with going further, towards docutils 0.22+. The following are extracts from the errors failing the build process (tested on Sphinx 9.1.0 and docutils 0.22.4). I have error logs with full tracebacks and more details available if needed.
Errors
peps/pep-0554.rst:29: (ERROR/3) Indirect hyperlink target (id="concurrency") refers to target "concurrency", which is a duplicate, and cannot be used as a unique reference.peps/pep-0683.rst:476: (ERROR/3) Indirect hyperlink target (id="documentation") refers to target "documentation", which is a duplicate, and cannot be used as a unique reference.peps/pep-0426.rst:748: (ERROR/3) Duplicate target name, cannot be used as a unique reference: "extras".peps/pep-0653.rst:722: (WARNING/2) Footnote content expected.peps/pep-0827.rst:1963: (WARNING/2) Footnote content expected.peps/pep-0697.rst:250: (ERROR/3) Indirect hyperlink target (id="reference-implementation") refers to target "reference implementation", which is a duplicate, and cannot be used as a unique reference.peps/pep-0791.rst:163: (ERROR/3) Indirect hyperlink target (id="id1") refers to target "motivation", which is a duplicate, and cannot be used as a unique reference.
All of those errors are coming from docutils, not from Sphinx, but they are hard-failing the parallel Sphinx builds.
CC @hugovk
EDIT: After investigation, only docutils is blocked. Sphinx 9 works fine.
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
Bắt đầu bằng cách tái hiện bản build Sphinx song song với Sphinx 9.1.0 và docutils 0.22.4, sau đó kiểm tra các vị trí được báo cáo trong peps/pep-0554.rst, peps/pep-0683.rst, peps/pep-0426.rst, peps/pep-0653.rst, peps/pep-0827.rst, peps/pep-0697.rst và peps/pep-0791.rst. Công việc được xem là hoàn tất khi các lỗi và cảnh báo docutils được liệt kê không còn khiến bản build bị hard-fail, đồng thời vẫn giữ nguyên nội dung PEP.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- build-system, documentation
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 55/100