Way to Auto-run the examples.

What should we add?

We have a bunch of examples (though not enough) in the docs dir -- but it's hard to know if they still work, as things change.

It would be good to set up a way to auto-run all the examples, then we could put that in the CI, and know when / if they break.

They are mostly Jupyter notebooks, but some scripts too.

I think the way to run a Juyter notebook is to nbconvert it to a script, then run that, but maybe there's another way now?

I've done things like this in the past by haveing a python script that finds all the examples and runs them (in a subprocess), and make s areport if any fail. But maybe there's a pre-existing package that can do it more automagically?

Reference

No response

Start by inventorying the notebooks and scripts in the docs directory and determine how each example can be run non-interactively, including whether nbconvert is suitable. Evaluate an existing Python runner or package, then define a CI check that executes all examples and reports failures. Done means the examples run automatically and failures are visible in CI.