blackjax-devs
Use `jupytext`-compatible markdown files instead of notebooks?
Notebooks don't work well with versioning, but the markdown files produced by jupytext do. I suggest we only version the markdown versions in the repository, and render the notebooks for the documentation.
Edit: We use MyST-nb to build documentation from notebooks, and it does support notebooks in jupytext format. It is just a matter of converting the notebooks and configure the build in CI.
I am looking to take this issue along with https://github.com/blackjax-devs/blackjax/issues/160.
By converting notebooks, do you mean just use myst-nb on all notebooks in example? what about configuring the build in CI? could you elaborate more on both tasks? thank you.
I mean that the blackjax repository should only have notebooks in the jupytext format. Notebooks are rendered in CI to display in the documentation.
I see. I just noticed you have assigned yourself to this issue. If you've already started working on this issue already, I can take a look at other issues. thank you.
I haven't actually started so feel free to pick it up. It's best to start with one example and open a draft PR to set things up and for feedback.