labthings / labthings/python-labthings
RTD documentation
Đang mở
Chưa có ai nhận issue này.
critical
documentation
in progress
- Ngôn ngữ chính
- Python
- Star
- 19
- Fork
- 2
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
A lot of stuff can be generated using Sphinx autodocs.
A lot of the documentation around writing Things and Extensions can be taken from the OpenFlexure Microscope docs with little change.
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 tài liệu Sphinx của dự án và phần mã được autodocs bao phủ. Xem tài liệu OpenFlexure Microscope để tìm nội dung về cách viết Things và Extensions, sau đó xác định những gì áp dụng ở đây. Được xem là hoàn tất khi tài liệu liên quan được tạo hoặc điều chỉnh cho python-labthings và xây dựng thành công.
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ó
- 4/5
- Thời gian dự kiến
- 3-5 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
- 30/100