classification
Title: Sphinx conf.py needs_version entry is outdated
Type: Stage:
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, mdk, terry.reedy, timhoffm
Priority: normal Keywords:

Created on 2021-01-04 01:28 by timhoffm, last changed 2021-01-08 23:35 by terry.reedy.

Messages (2)
msg384305 - (view) Author: Tim Hoffmann (timhoffm) * Date: 2021-01-04 01:28
The sphinx conf.py entry `needs_version=1.8` (https://github.com/python/cpython/blob/1470edd6131c29b8a09ce012cdfee3afa269d553/Doc/conf.py#L48)

is not in sync with the doc build requirements (https://github.com/python/cpython/blob/1470edd6131c29b8a09ce012cdfee3afa269d553/Doc/requirements.txt#L6)

Possible solutions:
a) Drop the `needs_version` config value. It's optional.
b) Make sure to update both places.
c) Or at minimum add a comment that `needs_version` is only a safeguard against very old sphinx versions but is not necessarily sufficient to build.
msg384697 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2021-01-08 23:35
This is related to #42843, which is about deciding what the min sphinx should be.  Since the alternative to 3.2 is some 2.x, 1,8 is certainly wrong.
History
Date User Action Args
2021-01-08 23:35:42terry.reedysetnosy: + terry.reedy
messages: + msg384697
2021-01-08 22:59:56terry.reedysetnosy: + mdk
2021-01-04 01:28:14timhoffmcreate