This PR adds an mkdocs_gen_files script that converts Jupytext
notebooks in the py:percent format under the docs/tutorials/ folder
into ipynb notebooks, so they can be executed by mknotebooks.
This will allow us to keep the notebooks in a more reviewable file
format, but also benefit from mknotebooks improved output rendering
when compared to mkdocs-jupyter (which can process Jupytext files
natively, but lacks support for advanced Markdown features provided
by mkdocs-material).
I've excluded the docs/tutorials folder from linting with ruff/bandit for
now due to excessive warnings. We can define appropriate rules if we
decide to keep this change.
This PR adds an
mkdocs_gen_filesscript that converts Jupytext notebooks in thepy:percentformat under thedocs/tutorials/folder into ipynb notebooks, so they can be executed by mknotebooks.This will allow us to keep the notebooks in a more reviewable file format, but also benefit from mknotebooks improved output rendering when compared to mkdocs-jupyter (which can process Jupytext files natively, but lacks support for advanced Markdown features provided by mkdocs-material).
I've excluded the
docs/tutorialsfolder from linting with ruff/bandit for now due to excessive warnings. We can define appropriate rules if we decide to keep this change.This change is