Add .readthedocs.yml (#143)

scrapy · Dec 19, 2023 · ec4d1ea · ec4d1ea
1 parent 8e7ad50
commit ec4d1ea
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,15 @@
+version: 2
+formats: all
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+build:
+  os: ubuntu-22.04
+  tools:
+    # For available versions, see:
+    # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python
+    python: "3.12"  # Keep in sync with .github/workflows/checks.yml
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - path: .
diff --git a/docs/conf.py b/docs/conf.py
@@ -95,7 +95,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'classic'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx==7.2.6
+sphinx-rtd-theme==2.0.0
diff --git a/tox.ini b/tox.ini
@@ -41,8 +41,7 @@ commands =
 [testenv:docs]
 changedir = docs
 deps =
-    sphinx
-    sphinx_rtd_theme
+    -r docs/requirements.txt
 commands =
     sphinx-build -W -b html . {envtmpdir}/html