fix: pin nbconvert <7.14 to re-run examples (#393)

Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Substra · Feb 29, 2024 · 2d88e7d · 2d88e7d
1 parent 74b145c
commit 2d88e7d
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 5 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -56,7 +56,7 @@ jobs:
 
       - name: Install requirements
         run: |
-          pip install -r docs/doc-requirements.txt
+          pip install -r requirements.txt
 
       - name: Sphinx make
         working-directory: ./docs

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Rename `predictions_path` to `predictions` in metrics ([#376](https://github.com/Substra/substra-documentation/pull/376))
 - Pass `metric_functions` to `Strategy` instead to `TestDataNodes` ([#376](https://github.com/Substra/substra-documentation/pull/376))
 
+### Added
+
+- Pin `nbconvert` to 7.13 to reactivate examples run when building (cf issue https://github.com/spatialaudio/nbsphinx/issues/776) ([#393](https://github.com/Substra/substra-documentation/pull/393))
+
 ## [0.35.0]
 
 ### Added

diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt
@@ -13,4 +13,5 @@ sphinx-copybutton==0.5.2
 pyyaml==6.0
 nbsphinx==0.9.3
 pandoc==2.3
-git-python==1.0.3
+git-python==1.0.3
+nbconvert<7.14
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -7,4 +7,4 @@ dependencies:
   - pandoc=3.1
   - pip
   - pip:
-      - -r doc-requirements.txt
+      - -r ../requirements.txt
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -116,7 +116,6 @@ def __call__(self, directory):
 """
 
 nbsphinx_epilog = nbsphinx_prolog
-nbsphinx_execute = "never"
 
 
 # zip the assets directory found in the examples directory and place it in the current dir

diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,2 @@
--r docs/docs-requirements.txt
+-r docs/doc-requirements.txt
 -r examples_requirements.txt