Follow-up for after the JB2 switch
未关闭
还没有人认领这个 Issue。
enhancement
infrastructure
maintenance
- 主要语言
- 没有语言数据
- 星标
- 673
- 派生
- 229
- PR 合并指标
- 30 天内没有已合并 PR
描述
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)
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
检查 #274 以及剩余未勾选的项目,从 tox 配置、environment.yaml、README/contributor guide 和 deployment GitHub Actions workflow 开始。确认哪些构建警告、链接语法、部署行为、环境工具和 fork 触发条件仍然适用。完成意味着适用的后续工作已经完成,或已拆分为目标明确的 issues。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github-actions, latex, yaml
- 领域
- build-system, ci-cd, documentation
- Issue 类型
- 重构
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 25/100