aai-institute / aai-institute/kyle
Documentation build out of sync wrt pypi
- Ngôn ngữ chính
- Jupyter Notebook
- Star
- 14
- Fork
- 1
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Docs are built from develop => out of sync with releases. I think pages should only be built from master, after a release to pypi. Alternatively, one could maintain versions for all tags, allowing to switch between them, like in read the docs, but doing that manually would be a pita.
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
Hướng nghiên cứu
Xem cấu hình GitHub Pages trong phần cài đặt repository hoặc các tệp workflow (như .github/workflows) để biết tài liệu hiện đang được build như thế nào. Kiểm tra xem có script hoặc CI job nào được kích hoạt khi push lên develop thay vì master hay không. Tìm hiểu quy trình release lên pypi và cách các bản cập nhật tài liệu cần được đồng bộ với các release đã gắn tag. Mục tiêu là điều chỉnh nguồn build từ develop sang master hoặc triển khai một chiến lược versioning.
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
- build-system, documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- 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
- 45/100