Speed up doc builds

[huard]

Addressing a Problem?

Compiling the documentation takes a really long time. Makes debugging math equations really painful.

Potential Solution

myst-nb has options to cache the notebooks.

Additional context

No response

Contribution

• I would be willing/able to open a Pull Request to contribute this feature.

Code of Conduct

• I agree to follow this project's Code of Conduct

[Zeitsperre]

See also #1439

[huard]

Sometime make html goes through all the notebooks, and sometimes it doesn't. Confused as to what triggers this, but has a large impact on build time.

[Zeitsperre]

This isn't well documented, but it's due to an environment flag-based workaround I added to help with speeding things up:

xclim/docs/conf.py

Line 215 in f8c3abe

skip_notebooks = os.getenv("SKIP_NOTEBOOKS")

If your shell has SKIP_NOTEBOOKS defined, the notebooks will not be run. For ReadTheDocs, the notebooks will conditionally be run (auto/always) depending on whether the trigger was coming from a pull request or from main.

This should be made much clearer in the contributing documentation at the very least.