Skip to content

Conversation

@sorcio
Copy link
Contributor

@sorcio sorcio commented May 29, 2022

#92318 introduced changes that require a minimum Sphinx version of 3.2, so needs_sphinx needs to be updated accordingly. The change was backported to 3.11 and 3.10 so the same should apply for this PR (see also discussion in the issue #86986 (comment)).

@AA-Turner AA-Turner added the docs Documentation in the Doc dir label May 29, 2022
@AA-Turner AA-Turner requested a review from JulienPalard May 29, 2022 20:45
@AA-Turner
Copy link
Member

From the issue we might be able to bump to 3.4, but I don't know how conservative we want to be here.

A

@AA-Turner
Copy link
Member

@sorcio please add a NEWS entry, this is relevant for redistributors.

A

@sorcio
Copy link
Contributor Author

sorcio commented May 29, 2022

From the issue we might be able to bump to 3.4, but I don't know how conservative we want to be here.

Currently there are no features that need 3.4, so maybe it's not necessary. Looking at the changelog for Sphinx 3.3 and 3.4 there doesn't seem to be much of value for CPython docs anyway. If I were to guess, the next time a bump is going to be needed it's probably going to be >= 4.5. So right now 3.2 seems appropriate because it documents the minimum version that is known to work.

(Speaking of, it might be useful to point out in https://github.com/python/devguide/blob/main/documenting.rst how to find which Sphinx version to install, when not using make venv)

@ambv ambv added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Jun 7, 2022
@ambv ambv merged commit 57e8ee7 into python:main Jun 7, 2022
@miss-islington
Copy link
Contributor

Thanks @sorcio for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

GH-93561 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jun 7, 2022
@bedevere-bot
Copy link

GH-93562 is a backport of this pull request to the 3.10 branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants