lincc-frameworks / lincc-frameworks/python-project-template
RTD template: switch to sphinx_book_theme HTML theme
Đang mở
Chưa có ai nhận issue này.
enhancement
- Ngôn ngữ chính
- Jinja
- Star
- 85
- Fork
- 16
- Merge trung bình
- 6 giờ 18 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
sphinx_book_theme is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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 xác định cấu hình Read the Docs trong template và xem lại các issue #518 và #500 để biết các yêu cầu liên quan. Kiểm tra cách theme HTML hiện tại được chọn và cập nhật template để các project được tạo sử dụng sphinx_book_theme một cách nhất quán; hoàn tất nghĩa là tài liệu được build bằng theme mới.
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
- documentation
- 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
- Cần làm rõ
- Mức phù hợp với người mới
- 35/100