The tutorials are not included in the docs anymore

[jobrachem]

As @GianmarcoCallegher pointed out, the tutorials are currently not included in the documentation anymore.

• Re-running the GitHub action has not resolved the issue.
• The action does correctly and successfully execute the notebooks, and include them in its artifact
• Inspecting the build logs on readthedocs has not given me any hint as to why we have this problem now
• The last version of the docs with working tutorials seems to be v0.2.8

I am uncertain about how we can fix this. We are relying on a small project, https://github.com/dfm/rtds-action, for our setup here, and have some reliability issues before.

The major alternative that I see would be to commit the rendered tutorial notebooks to our repository. The main downside of this alternative would be the fact that we would be committing images to the version control, thus increasing the size of the repository.

[jobrachem]

In the discussion during the last weekly, the following solution emerged:

1. Commit the rendered tutorials to the repository - this will make the CI pipeline with RTD work more robustly.
2. Do not commit a new version of the tutorials with every commit. Instead, commit new versions only if necessary. This will prevent the repository from being filled with bloat (the images generated in the tutorials).
3. Run the tutorials in the CI for PRs to the main branch without committing the rendered results. This will alert us to errors in the tutorials and enable us to trigger a manual tutorial re-build if necessary.

With this solution, the tutorials lose a small bit of effectiveness as integration tests, since they are not re-run with every commit to main. However, we can still be certain that the code runs without error (by 3.). And after all, ensuring the correctness of the software is the job of the unit tests, not per se the job of the tutorials - their main responsibility is to teach.