Follow-up for after the JB2 switch
Here are items we left for follow-ups after #274
- [x] 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
- [ ] 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)
~- [ ] Request extended amsmath support for LaTeX math rendering. See e.g. https://numpy.org/numpy-tutorials/mooreslaw-tutorial/#building-moores-law-as-an-exponential-function~ added this to the list above (bsipocz)
The latex issue would also solve a bunch of the errors we get for the strict run. And I'm sure there is a solution for it already, I just haven't yet dived into the latex solutions in myst, it's a bit different than in python, but I'm sure it already exists.
The latex issue would also solve a bunch of the errors we get for the strict run. And I'm sure there is a solution for it already, I just haven't yet dived into the latex solutions in myst, it's a bit different than in python, but I'm sure it already exists.
I think the place to start looking is: https://mystmd.org/guide/math
There's a lot of info there about different math renderers etc. (I've never heard of typst for example)
So cool to see things live!!! 🚀
Another one on the list is to add to the gallery here: https://jupyterbook.org/latest/gallery
@rowanc1 - yeap, adding this and a bunch of other projects to the gallery is on my list :)