Execute notebooks on rtd. Closes #469

[hmgaudecker]

What problem do you want to solve?

Automate building the documentation.

• Execute notebooks as part of the rtd build.
• Add pre-commit hook to commit empty notebooks only
• Use mamba on rtd
• Document PR in docs/changes.rst.

[codecov]

Codecov Report

Base: 91.41% // Head: 91.41% // No change to project coverage 👍

Coverage data is based on head (6e81467) compared to base (a672088).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #470   +/-   ##
=======================================
  Coverage   91.41%   91.41%           
=======================================
  Files          77       77           
  Lines        4006     4006           
=======================================
  Hits         3662     3662           
  Misses        344      344           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[janosg]

Nice!

Just one stupid question: I don't see where you trigger the actual build of the notebook such that it is displayed with output in the online documentation. Is this a readthedocs setting or did I miss something?

[hmgaudecker]

I don't see where you trigger the actual build of the notebook such that it is displayed with output in the online documentation.

This is nbsphinx' default behaviour: https://nbsphinx.readthedocs.io/en/0.8.11/usage.html#nbsphinx_execute

Other useful references:

• https://nbsphinx.readthedocs.io/en/0.8.11/allow-errors.html
• https://nbsphinx.readthedocs.io/en/0.8.11/allow-errors-per-cell.html