Update RTD setup and create .readthedocs.yaml (#479)

NicolasHug · May 19, 2024 · 825ad92 · 825ad92
1 parent 79bcd39
commit 825ad92
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 6 deletions.
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -26,8 +26,9 @@ jobs:
         python-version: ${{ matrix.python-version }}
     - name: Install Surprise with docs dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install ".[docs]"
+        pip install --upgrade pip
+        cd doc
+        pip install -r requirements.txt
     - name: Build docs
       run: |
         cd doc

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: doc/source/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,5 @@
+sphinx
+sphinx_rtd_theme
+sphinxcontrib-bibtex
+sphinxcontrib-spelling
+pandas
diff --git a/pyproject.toml b/pyproject.toml
@@ -26,10 +26,6 @@ dependencies = [
 ]
 dynamic = ["version", "readme"]
 
-[project.optional-dependencies]
-test = ["pytest", "pandas"]
-docs = ["sphinx", "sphinx_rtd_theme", "sphinxcontrib-bibtex", "sphinxcontrib-spelling"]
-
 [project.scripts]
 surprise = "surprise.__main__:main"