diff options
| author | Carlton Gibson <carlton@noumenal.es> | 2021-11-03 18:35:27 +0100 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2021-11-03 18:55:32 +0100 |
| commit | 9d171643d468aee2d61bf46cebfcbfe96df41d2d (patch) | |
| tree | fa7efa9745df2ff5b718d1fd60cc37024245bba9 | |
| parent | 327dac6e7ce630d80111f48f29984bae8ca304d7 (diff) | |
[3.2.x] 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.
Backport of 447b6c866f0741bb68c92dc925a65fb15bfe7995 from main.
| -rw-r--r-- | .readthedocs.yml | 9 | ||||
| -rw-r--r-- | docs/requirements.txt | 3 |
2 files changed, 9 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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..6ea1372680 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +pyenchant +Sphinx>=3.1.0 +sphinxcontrib-spelling |