From ce6fb8b2265b235d3c9c76694fcb1b1ba67c60dc Mon Sep 17 00:00:00 2001
From: Guillaume Fraux <guillaume.fraux@epfl.ch>
Date: Tue, 19 Dec 2023 17:33:40 +0100
Subject: [PATCH] Update documentation dependencies

---
 docs/requirements.txt   | 4 ++--
 docs/src/.gitignore     | 1 +
 docs/src/conf.py        | 8 ++++++--
 scripts/clean-python.sh | 2 ++
 tox.ini                 | 1 -
 5 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/docs/requirements.txt b/docs/requirements.txt
index 943d98e85..53a1b3986 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,5 +1,5 @@
-# sphinx dependencies
-sphinx < 7.2    # breathe is not compatible with sphinx 7.2 yet
+# sphinx and dependencies
+sphinx == 7.2.6
 furo            # sphinx theme
 breathe >=4.33  # C and C++ => sphinx through doxygen
 sphinx-gallery  # convert python files into nice documentation
diff --git a/docs/src/.gitignore b/docs/src/.gitignore
index 1e107f52e..9c18e99c6 100644
--- a/docs/src/.gitignore
+++ b/docs/src/.gitignore
@@ -1 +1,2 @@
 examples
+sg_execution_times.rst
diff --git a/docs/src/conf.py b/docs/src/conf.py
index a8d8a21da..7ac775f63 100644
--- a/docs/src/conf.py
+++ b/docs/src/conf.py
@@ -109,7 +109,11 @@ def setup(app):
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["Thumbs.db", ".DS_Store"]
+exclude_patterns = [
+    "Thumbs.db",
+    ".DS_Store",
+    "sg_execution_times.rst",
+]
 
 
 autoclass_content = "both"
@@ -120,7 +124,7 @@ def setup(app):
     "filename_pattern": "/*",
     "examples_dirs": ["../../python/rascaline/examples"],
     "gallery_dirs": ["examples"],
-    "min_reported_time": 60,
+    "min_reported_time": 5,
     # Make the code snippet for rascaline functions clickable
     "reference_url": {"rascaline": None},
     "prefer_full_module": ["rascaline"],
diff --git a/scripts/clean-python.sh b/scripts/clean-python.sh
index 992aa6c06..ef27ea871 100755
--- a/scripts/clean-python.sh
+++ b/scripts/clean-python.sh
@@ -11,6 +11,8 @@ cd "$ROOT_DIR"
 rm -rf dist
 rm -rf build
 rm -rf .coverage
+rm -rf docs/build
+rm -rf docs/src/examples
 
 rm -rf python/rascaline-torch/dist
 rm -rf python/rascaline-torch/build
diff --git a/tox.ini b/tox.ini
index 0eec76844..602fbad61 100644
--- a/tox.ini
+++ b/tox.ini
@@ -114,7 +114,6 @@ commands =
     # install rascaline-torch
     pip install python/rascaline-torch --no-deps --no-build-isolation --force-reinstall
 
-    bash -c "rm -rf docs/src/examples"
     sphinx-build {posargs:-E} -W -b html docs/src docs/build/html