Skip to content

Conversation

@reint-fischer
Copy link
Contributor

@reint-fischer reint-fischer commented Nov 6, 2025

Implementing MyST-NB as a sphinx extension will replace both nbsphinx and myst_parser. This way, we can read and execute both .md and .ipynb notebooks, which will allow us to write new notebooks in .md for better integration with the rest of the documentation.

TODO

  • add myst_nb remove myst_parser
  • transfer .ipynb execution from nbspinx to myst_nb
  • Execute quickstart tutorial on docs build
  • Execute quickstart tutorial during CI?
  • Fix User Guide links: nbgallery alternative in MyST-NB
  • Finish writing quickstart tutorial as .md notebook

Fixes #2335

@reint-fischer reint-fischer marked this pull request as draft November 6, 2025 13:47
@reint-fischer
Copy link
Contributor Author

I managed to build the docs using MyST-NB and I think the docs look pretty good, which I think is exciting! The main observations I have so far:

  • building the docs already took a couple of minutes with only 5 notebooks, but that was only the first time. Notebooks are only executed if they have changed so once I am only working on the quickstart tutorial it is pretty much as quick as before.
  • writing new notebooks is more challenging because I cannot execute the cells in VS Code as I am editing them. There might be a way to do this?
  • I still need to look into the printing of outputs, such as the progressbar and with the docs in “dark mode"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Handling of tutorial notebook cell outputs in v4

2 participants