Standardisation of sphinx docs page titles
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- build-system, documentation
Hướng nghiên cứu
Trước tiên, hãy xem trang ví dụ tại https://diamondlightsource.github.io/python-copier-template/main/how-to.html và phần thảo luận của issue, vì không có tệp nguồn hoặc test nào được nêu. Xác nhận rằng dự án đã thống nhất về một quy ước đặt tiêu đề và xác định điểm vào của quá trình build tài liệu trước khi xác định phạm vi của một kiểm tra; được xem là hoàn tất khi quy ước đó được nêu rõ và build thực thi quy ước một cách nhất quán.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.
(from https://diamondlightsource.github.io/python-copier-template/main/how-to.html)
It annoys me that the titles for docs pages are not really standardised, Some Are Capitalised, some are not, some are prefixed with "How to" or similar. If there is a really easy check that can be added to the docs builds it might add a layer of consistency and professionalism. The hardest part, as ever when we talk about formatting, may be agreeing on which standard to use.
- Ngôn ngữ chính
- Jinja
- Star
- 25
- Fork
- 10
- Merge trung bình
- 4 ngày 17 giờ
- Pull request đã merge (30 ngày)
- 7
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.
Issue khác của DiamondLightSource/python-copier-template
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 68/100
-
documentation good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
Tất cả issue của DiamondLightSource/python-copier-template
Issue tương tự
-
status: needs triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
conda-forge/spacy-feedstock#177 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
area:jail bug security severity:low track:open-source
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
micro-ROS/micro_ros_setup#837 ·