numpy / numpy/numpy-tutorials

Follow-up for after the JB2 switch

オープン
#280 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

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#2447 this 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)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

#274 と残っている未チェック項目を確認し、tox の設定、environment.yaml、README/contributor guide、deployment GitHub Actions workflow から始めます。どの build 警告、リンク構文、deployment の動作、環境ツール、fork からのトリガー条件が引き続き該当するかを確認します。該当するフォローアップが完了するか、目的を絞った issue に分割されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
github-actions, latex, yaml
領域
build-system, ci-cd, documentation
issue の種類
リファクタリング
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。