Fix Numba Compilation Timeout in Docs (#1223)

philipc2 · web-flow · commit a13ddca5a4a0 · 2025-04-25T20:15:20.000-05:00
* update nbsphinx timeout

* update .readthedocs.yml

* fix typo in doc

* fix typo in doc

* use python 3.12 for docs

* set nb execution timeout

* clean notebook output

* unpin python
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,21 +1,22 @@
-# .readthedocs.yml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
 version: 2
 
 build:
-  os: "ubuntu-20.04"
+  os: ubuntu-lts-latest
   tools:
-    python: "mambaforge-4.10"
+    python: mambaforge-latest
   jobs:
+    post_checkout:
+      - git fetch --unshallow || true
+    pre_install:
+      - git update-index --assume-unchanged docs/conf.py ci/docs.yml
     post_create_environment:
       - pip install . --no-deps -vv
 
-# Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
+  fail_on_warning: false
 
 conda:
   environment: ci/docs.yml
+
+formats: []
diff --git a/docs/conf.py b/docs/conf.py
@@ -80,6 +80,10 @@ def __getattr__(cls, name):
     "xarray": ("http://xarray.pydata.org/en/stable/", None),
 }
 
+
+# Notebook execution (per cell)
+nb_execution_timeout = 120
+
 remove_from_toctrees = ["generated/*"]
 
 napoleon_use_admonition_for_examples = True
diff --git a/docs/user-guide/subset.ipynb b/docs/user-guide/subset.ipynb

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,10 @@ def __getattr__(cls, name):`
`80`	`80`	`"xarray": ("http://xarray.pydata.org/en/stable/", None),`
`81`	`81`	`}`
`82`	`82`
	`83`	`+`
	`84`	`+# Notebook execution (per cell)`
	`85`	`+nb_execution_timeout = 120`
	`86`	`+`
`83`	`87`	`remove_from_toctrees = ["generated/*"]`
`84`	`88`
`85`	`89`	`napoleon_use_admonition_for_examples = True`