1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00

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.
This commit is contained in:
Carlton Gibson 2021-11-03 18:35:27 +01:00 committed by GitHub
parent 0da7a2e9da
commit 447b6c866f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 4 deletions

View File

@ -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

View File

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