Ensure in docs build that cell execution doesn't timeout (#25)

* Ensure in docs build that cell execution doesn't timeout Fixes #24 * changelog
mllam · Sep 25, 2024 · 1d1407b · 1d1407b
1 parent 40779d0
commit 1d1407b
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -34,6 +34,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   [\#19](https://github.com/mllam/weather-model-graphs/pull/19)
   @joeloskarsson
 
+### Maintenance
+
+- Ensure that cell execution doesn't time out when building jupyterbook based
+  documentation [\#25](https://github.com/mllam/weather-model-graphs/pull/25),
+  @leifdenby
+
 ## [v0.1.0](https://github.com/mllam/weather-model-graphs/releases/tag/v0.1.0)
 
 First tagged release of `weather-model-graphs` which includes functionality to

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -9,6 +9,12 @@ author: The ML LAM Community
 # See https://jupyterbook.org/content/execute.html
 execute:
   execute_notebooks: force
+  # ensure that cell execution doesn't timeout (this is necessary because
+  # creating some of the figures takes a long time)
+  # see https://github.com/jupyter-book/jupyter-book/issues/948 and
+  # https://jupyterbook.org/en/stable/content/execute.html#setting-execution-timeout
+  # for details
+  timeout: -1
 
 # Define the name of the latex output file for PDF builds
 latex: