geodynamics / Rayleigh

Rayleigh: Pseudo-spectral MHD
GNU General Public License v3.0
61 stars 48 forks source link

Documentation: Jupyter notebook python output #353

Closed feathern closed 2 years ago

feathern commented 2 years ago

There are several places in the documentation where the build process is attempting to run Python code that relies on nonexistent files (on the documentation server). These are typically cells that illustrate plotting examples. It would be good to adjust this so that the python code is displayed, but not executed, so that the documentation does not appear broken in places.

A prime example can be seen here.

gassmoeller commented 2 years ago

Some documentation about how to exclude notebooks from running in sphinx: https://nbsphinx.readthedocs.io/en/0.8.8/never-execute.html