chore: update ReadTheDocs config file to be compliant (#439)

* add build.os config setting for readthedocs * set lower bound of readthedocs Sphinx theme to fix readthedocs CI --------- Co-authored-by: Alexander Held <[email protected]>
scikit-hep · Sep 20, 2023 · 80b4af1 · 80b4af1
1 parent 2af877c
commit 80b4af1
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/.readthedocs.yml → .readthedocs.yaml b/.readthedocs.yml → .readthedocs.yaml
@@ -5,17 +5,22 @@
 # Required
 version: 2
 
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-# Optionally build your docs in additional formats such as PDF
+# If using Sphinx, optionally build your docs in additional formats such as PDF and ePub
 formats:
   - pdf
 
-# Optionally set the version of Python and requirements required to build your docs
+# python -m pip install '.[docs,contrib]'
 python:
-  version: 3.8
   install:
     - method: pip
       path: .

diff --git a/setup.py b/setup.py
@@ -28,7 +28,7 @@
         "sphinx-click",
         "sphinx-copybutton",
         "sphinx-jsonschema",
-        "sphinx-rtd-theme",
+        "sphinx-rtd-theme>=1.2",  # Sphinx 7 compatibility
     }
 )