Skip to content

Commit

Permalink
[3.2.x] Refs #33247 -- Corrected configuration for Read The Docs.
Browse files Browse the repository at this point in the history
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 447b6c8 from main.
  • Loading branch information
carltongibson authored and felixxm committed Nov 3, 2021
1 parent 327dac6 commit 9d17164
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
9 changes: 6 additions & 3 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pyenchant
Sphinx>=3.1.0
sphinxcontrib-spelling

0 comments on commit 9d17164

Please sign in to comment.