summaryrefslogtreecommitdiff
path: root/.readthedocs.yml
diff options
context:
space:
mode:
authorCarlton Gibson <carlton@noumenal.es>2021-11-03 18:35:27 +0100
committerGitHub <noreply@github.com>2021-11-03 18:35:27 +0100
commit447b6c866f0741bb68c92dc925a65fb15bfe7995 (patch)
tree9718896ff939d76a8468762a3fa429fcae12a059 /.readthedocs.yml
parent0da7a2e9dab81b622a2000536c6a96de7f46e237 (diff)
Refs #33247 -- Corrected configuration for Read The Docs.
This pins Sphinx version, because the default Sphinx version used by RTD is not compatible with Python 3.8+. This also, sets Python 3.8 for RTD builds which is compatible with all current versions of Django. Thanks to Mariusz Felisiak for the suggestion.
Diffstat (limited to '.readthedocs.yml')
-rw-r--r--.readthedocs.yml9
1 files changed, 6 insertions, 3 deletions
diff --git a/.readthedocs.yml b/.readthedocs.yml
index d6ca0316b3..18f81acab2 100644
--- a/.readthedocs.yml
+++ b/.readthedocs.yml
@@ -1,17 +1,20 @@
# Configuration for the Read The Docs (RTD) builds of the documentation.
# Ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
-# Note python.install.requirements is not currently required, as Sphinx is
-# preinstalled and spelling checks not performed by RTD.
+# The python.install.requirements pins the version of Sphinx used.
version: 2
build:
os: ubuntu-20.04
tools:
- python: "3.10"
+ python: "3.8"
sphinx:
configuration: docs/conf.py
+python:
+ install:
+ - requirements: docs/requirements.txt
+
formats:
- epub
- pdf