doc: Simplify building docs without notebook execution (#2873)

dweindl · web-flow · commit 11d1048616dc · 2025-07-04T06:51:37.000Z
For testing documentation builds it's annoying to wait for notebook execution to complete or modifying the configuration file.
With this change, setting an environment variable `AMICI_NO_NB_EXEC` to any value will skip notebook execution when building the documentation.
diff --git a/doc/conf.py b/doc/conf.py
@@ -227,6 +227,8 @@ def install_doxygen():
     """
 )
 
+nbsphinx_execute = "never" if os.environ.get("AMICI_NO_NB_EXEC") else "auto"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
diff --git a/tox.ini b/tox.ini
@@ -6,7 +6,7 @@ envlist =
     doc
 
 [testenv]
-passenv = AMICI_PARALLEL_COMPILE,CC,CXX,GITHUB_ACTIONS
+passenv = AMICI_PARALLEL_COMPILE,CC,CXX,GITHUB_ACTIONS,AMICI_NO_NB_EXEC
 
 [testenv:doc]
 description =

Original file line number	Diff line number	Diff line change
`@@ -227,6 +227,8 @@ def install_doxygen():`
`227`	`227`	`"""`
`228`	`228`	`)`
`229`	`229`
	`230`	`+nbsphinx_execute = "never" if os.environ.get("AMICI_NO_NB_EXEC") else "auto"`
	`231`	`+`
`230`	`232`	`# Add any paths that contain templates here, relative to this directory.`
`231`	`233`	`templates_path = ["_templates"]`
`232`	`234`