[mkdocs] Add github action that tests the build of the example pages
Đang mở
Chưa có ai nhận issue này.
bug
P1
- 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ả
Right now we build the examples from jupyter notebooks here
https://github.com/plotly/plotly.py/blob/main/.circleci/config.yml#L356-L388
If any notebook outputs an error the build fails and the docs won't publish
We need to implement something similar for the new docs so we don't end up showing failures on published pages
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 bằng cách đọc các bước build notebook trong .circleci/config.yml ở các dòng 356-388 và so sánh chúng với build trang ví dụ MkDocs mới. Xác định check của GitHub Actions sao cho các lỗi đầu ra của notebook khiến build thất bại trước khi phát hành tài liệu; hoàn thành khi workflow phát hiện được các lỗi đó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions, jupyter-notebook, python
- Lĩnh vực
- build-system, ci-cd, 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
- Khá rõ ràng
- Mức phù hợp với người mới
- 42/100