1
0
mirror of https://github.com/django/django.git synced 2025-07-04 17:59:13 +00:00

[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.
This commit is contained in:
Carlton Gibson 2021-11-03 18:35:27 +01:00 committed by Mariusz Felisiak
parent 327dac6e7c
commit 9d171643d4
2 changed files with 9 additions and 3 deletions

View File

@ -1,17 +1,20 @@
# Configuration for the Read The Docs (RTD) builds of the documentation. # Configuration for the Read The Docs (RTD) builds of the documentation.
# Ref: https://docs.readthedocs.io/en/stable/config-file/v2.html # Ref: https://docs.readthedocs.io/en/stable/config-file/v2.html
# Note python.install.requirements is not currently required, as Sphinx is # The python.install.requirements pins the version of Sphinx used.
# preinstalled and spelling checks not performed by RTD.
version: 2 version: 2
build: build:
os: ubuntu-20.04 os: ubuntu-20.04
tools: tools:
python: "3.10" python: "3.8"
sphinx: sphinx:
configuration: docs/conf.py configuration: docs/conf.py
python:
install:
- requirements: docs/requirements.txt
formats: formats:
- epub - epub
- pdf - pdf

3
docs/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
pyenchant
Sphinx>=3.1.0
sphinxcontrib-spelling