Add an extra script in `Contributing` to install some of the extra `Doc` requirements i.e. to make it easier to dev & QA
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 18.8k
- Fork
- 2.8k
- Merge trung bình
- 16 giờ 26 phút
- Pull request đã merge (30 ngày)
- 21
Mô tả
Using these commands from Contributing
(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
won't install modules e.g. wget, datashader, etc. that are used in docs.
I suggest we add optional-doc-requirements.txt to help install some of these modules so that we could more efficiently test the examples using:
jupyter-notebook doc/python
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.
Hướng nghiên cứu
Bắt đầu với phần “Install requirements — non-windows” trong contributing.md và các tệp packages/python/plotly/requirements.txt và optional-requirements.txt hiện có. Xem lại các ví dụ tài liệu trong doc/python và xác định các module bổ sung được sử dụng ở đó, bao gồm wget và datashader. Công việc được xem là hoàn tất khi một tệp optional-doc-requirements.txt và hướng dẫn cập nhật cho contributor cho phép kiểm thử các ví dụ bằng jupyter-notebook doc/python.
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, python
- Lĩnh vực
- documentation
- Loại issue
- Tính năng
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 55/100