python / python/peps

PEP 12: Add list of intersphinx mappings

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

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ả

PEP 12 is very helpful in writing PEPs and has a section on intersphinx. However, to know the available intersphinx mappings, one has to know where to look in the sphinx configuration.

I think it would be useful to include the list directly in PEP 12.

Alternatively, if that is considered to be at too high a risk for getting outdated, one could add an explanation on where to find it.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu bằng cách xác định PEP 12 và cấu hình Sphinx được tham chiếu trong issue. Xác nhận các ánh xạ intersphinx được duy trì ở đâu, sau đó cập nhật PEP 12 với danh sách hoặc giải thích nơi người đọc có thể tìm thấy danh sách đó; được xem là hoàn tất khi có thể tìm thấy các ánh xạ hiện có mà không cần biết trước về cấu hình.

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
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
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
48/100

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.