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:
parent
0da7a2e9da
commit
447b6c866f
@ -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
|
||||||
|
@ -1,3 +1,3 @@
|
|||||||
pyenchant
|
pyenchant
|
||||||
sphinx
|
Sphinx>=3.1.0
|
||||||
sphinxcontrib-spelling
|
sphinxcontrib-spelling
|
||||||
|
Loading…
Reference in New Issue
Block a user