Follow-up for after the JB2 switch
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 673
- Fork
- 229
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Here are items we left for follow-ups after #274
- build time on CircleCI is significantly longer than it was with JB1. I could easily consider this as a follow-up though.
From rossbar: I'm considering this "resolved" - I'm fairly confident the issue was the tox configuration not passing in the OMP_NUM_THREADS variable to the build environment. I just rebased #279 on main (after the JB2 switch) and re-ran the doc build. The sphinx-based run took 1m43 seconds to build, while JB2 took 1m17s 🚀
- cleaning up build errors and warnings -- currently we don't run with strict (and we didn't run with a similar manner as we were not failing JB1 builds with these broken links either)
- deployment not to a gh-pages branch -- this could probably be done as a follow-up, too and now just use the file we have. (I need to make my other repos consistent, too so can do this repo along with those).
- cleanup environment.yaml, switch to a more modern and reliable solution (eyeing pixi)
- change internal links to be myst syntax so they will have hover overs
- [ ] Request extended amsmath support for LaTeX math rendering. See e.g. numpy.org/numpy-tutorials/mooreslaw-tutorial#building-moores-law-as-an-exponential-function. cf. jupyter-book/mystmd#2447this has been worked around, but better LaTeX support would be nicer, which is an upstream issue - Update README/contributor guide for new JB2 patterns.
- deploy GHA should not run on forks (in fact the CI should not get triggered to run on forks -- add in conditionals)
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
Rà soát #274 và các mục còn lại chưa được đánh dấu, bắt đầu với cấu hình tox, environment.yaml, README/contributor guide và deployment GitHub Actions workflow. Xác nhận những cảnh báo build, cú pháp liên kết, hành vi deployment, công cụ môi trường và điều kiện kích hoạt từ fork nào vẫn còn áp dụng. Hoàn tất có nghĩa là các công việc tiếp theo áp dụng đã được hoàn thành hoặc được tách thành các issue tập trung.
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, latex, yaml
- Lĩnh vực
- build-system, ci-cd, documentation
- Loại issue
- Tái cấu trúc
- Độ 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
- 25/100