numpy / numpy/numpy-tutorials

Follow-up for after the JB2 switch

Aperta
#280 5 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement infrastructure maintenance
Lingua principale
Nessun dato sulla lingua
Stelle
673
Fork
229
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Esamina #274 e gli elementi rimanenti non spuntati, iniziando dalla configurazione di tox, environment.yaml, dal README/contributor guide e dal workflow di deployment di GitHub Actions. Conferma quali avvisi di build, sintassi dei link, comportamento del deployment, strumenti per l’ambiente e condizioni di attivazione dai fork sono ancora applicabili. Il lavoro è completato quando le attività successive applicabili sono state completate o suddivise in issue mirate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github-actions, latex, yaml
Ambito
build-system, ci-cd, documentation
Tipo di issue
Refactoring
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.