Migrate the production build chain (publish, cache, execution tests) to QuantEcon/mystmd after #363
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Tái cấu trúc
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- github-actions, jupyter-notebook, python
- Lĩnh vực
- build-system, ci-cd, documentation
Hướng nghiên cứu
Bắt đầu bằng cách so sánh ci.yml và build-ipynb.yml của #363 với publish.yml, cache.yml, execution-*.yml, environment.yml và lectures/myst.yml. Truy vết cách HTML production, PDF, các lượt tải notebook, bộ nhớ đệm và các bài kiểm tra thực thi hiện đang được build. Công việc được xem là hoàn tất khi các production surface còn lại không còn sử dụng jupyter-book 1.x, bộ nhớ đệm bao gồm các đầu vào ảnh hưởng đến việc thực thi, PDF đã được xem xét trực quan và các cảnh báo mystmd được liệt kê đã được giải quyết.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Goal
Finish what #363 starts: once the JB2 branch lands, the repo should be 100% QuantEcon/mystmd — no jupyter-book 1.x anywhere in the build chain. #363 deliberately migrates only the PR preview (ci.yml) and ipynb builds (build-ipynb.yml); everything production-facing still runs the JB1/Sphinx toolchain from main, driven by lectures/_config.yml + _toc.yml, which #363 replaces with myst.yml. Mixing the two long-term means every lecture edit is validated against one engine and published with another.
What still runs jupyter-book 1.x
| surface | current | mystmd path |
|---|---|---|
publish.yml HTML deploy |
jb build lectures |
myst build --html — already proven in ci.yml / build-ipynb.yml |
publish.yml PDF |
jb build --builder pdflatex |
typst export — a book-pdf export is already stubbed (commented) in lectures/myst.yml; needs building out and visual review |
publish.yml notebook downloads |
sphinx-tojupyter custom builder | myst build --ipynb — already prototyped in build-ipynb.yml, including the MyST-syntax-leak audit step |
cache.yml weekly execution cache |
jb build |
mirror of ci.yml's build, or retire in favour of ci.yml's cache (whose key is now engine-aware) |
execution-*.yml (linux/osx/win) |
pip install jupyter-book + Sphinx stack |
decide: port to mystmd, or retire — their purpose (execution regression) is partly covered by ci.yml now being a genuine cold-execution test |
environment.yml |
pins jupyter-book>=1.0.4post1,<2.0 |
replace with myst_requirements.txt as the single environment |
linkcheck_ignore in _config.yml |
Sphinx-only config | already duplicated into linkcheck.yml ignore-patterns (#592); retires with the file |
Housekeeping in the same sweep: cache.yml is still named "Build Cache [using jupyter-book]", and .github/workflows/_github_actions/ci.yml is a stale stashed copy of the old preview workflow.
Constraints and lessons to carry over (from the #363 incident, 2026-08-03)
Execution-affecting configuration must be inside the execution cache key — hash the workflow file and requirements alongside the lectures, as ci.yml now does, or an engine/env change ships green against stale outputs. Pin the mystmd fork by SHA and JAX by version. Keep XLA_PYTHON_CLIENT_PREALLOCATE=false (or successor policy from QuantEcon/meta#350) on any step that executes the JAX lectures concurrently on a single-GPU runner; the JB1 chain never needed it only because Sphinx executes sequentially. Keep the memory/dmesg telemetry pattern on GPU execution jobs.
Sequencing
This is follow-up work to #363, not part of it — it should land as its own PR(s) after #363 merges, with the PDF export likely the long pole (needs typst template work and visual signoff). Related: QuantEcon/meta#348 (shared build-lectures action) is the natural place for the standardised pieces to land once, and QuantEcon/meta#350 will supply the JAX-on-CI configuration defaults.
Carried over from #344 (consolidated 2026-08-04)
Two mystmd build warnings remain from the #342/#344 tracking pair (both closed in favour of this issue):
-
python_oop.md:12— index directive parse failure:single: OOP II: Building Classes(the second colon breaks parsing). Fix by rewording the entry, e.g.single: OOP II -- Building Classes. -
status.md:16—unknown directive: nb-exec-table(sphinx-tojupyter only). Needs a mystmd equivalent or a redesign of the execution-status page.
- Ngôn ngữ chính
- JavaScript
- Star
- 75
- Fork
- 36
- Merge trung bình
- 37 phút
- Pull request đã merge (30 ngày)
- 3
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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.
Issue khác của QuantEcon/lecture-python-programming
-
pandas: mean imputation corrupts Argentina's GDP per capita in the later plotCó thể làm lại được @omiiikb07 đã nhận 11 ngày trước và không có pull request nào đang mở. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
QuantEcon/lecture-python-programming#658 · 1 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 83/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 95/100
Tất cả issue của QuantEcon/lecture-python-programming
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 73/100
product-os/flowzone#2048 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 85/100
hugomrdias/playwright-test#786 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
code-review secondshift
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
piotrekno1/second-shift#419 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area:compiler effort:S impact:low platform:wasm type:chore
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
PolicyEngine/cliff-watch#55 ·
Maintainer thường phản hồi trong vòng 2 ngày