lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
Đ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ả
It would be great if the Read the Docs HTML documentation included buttons to download notebooks (as implemented in the LSDB RTD) and to run the notebooks on Google Colab.
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 xem xét cách tài liệu HTML của Read the Docs được tạo trong template này và so sánh với triển khai LSDB RTD được đề cập trong issue. Xác định nơi các trang notebook hoặc asset được cấu hình, sau đó kiểm tra để chắc chắn rằng tài liệu được tạo có các nút để tải notebook xuống và chạy chúng trên Google Colab.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- jupyter-notebook
- Lĩnh vực
- documentation
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 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