[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-15 Thread Senthil Kumaran
On Fri, Jan 15, 2021 at 08:24:54AM +, Julien Palard via Python-Dev wrote: > I think the best way to handle this is to make the three next releases > (3.10, 3.11, 3.12) Sphinx 2 and Sphinx 3 compatible, this would gather > requiered benefits: > > If this plan is OK for everyone, I'll try a

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-15 Thread Julien Palard via Python-Dev
Thanks everyone for the feedback. I think the best way to handle this is to make the three next releases (3.10, 3.11, 3.12) Sphinx 2 and Sphinx 3 compatible, this would gather requiered benefits: - Ease of backporting: from any dev version we can backport documentation changes to the previous

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Petr Viktorin
On 1/13/21 8:24 PM, Brett Cannon wrote: On Wed, Jan 13, 2021 at 7:25 AM Serhiy Storchaka > wrote: 12.01.21 22:38, Julien Palard via Python-Dev пише: > During the development of cpython 3.10, Sphinx was bumped to 3.2.1. > > Problem is Sphinx 3 have

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Gregory P. Smith
My take on this is to keep it simple for CPython: Require the newer version of Sphinx on all branches we backport docs changes to. We, the CPython project, determine the exact version(s) of Sphinx a documentation build for a given version of CPython requires. If Sphinx has unfortunately made a

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Brett Cannon
On Wed, Jan 13, 2021 at 7:25 AM Serhiy Storchaka wrote: > 12.01.21 22:38, Julien Palard via Python-Dev пише: > > During the development of cpython 3.10, Sphinx was bumped to 3.2.1. > > > > Problem is Sphinx 3 have some incompatibilities with Sphinx 2, some that > > we could work around, some are

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Carol Willing
Hi Julien, I think that there are two items to consider: - `needs_sphinx` in `conf.py` - setting for Sphinx in `cpython/Doc/requirements.txt` I believe that the `needs_sphinx` field identifies the minimal version of Sphinx that can be used to build the docs. The actual version that is used to

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Serhiy Storchaka
13.01.21 01:28, Victor Stinner пише: > I looked at Sphinx and Python versions of Debian, Ubuntu and Fedora: > https://bugs.python.org/issue42843#msg384963 > > In my list, there is only Debian Buster (stable) which doesn't have > Sphinx 3 yet. It uses Python 3.7 and so would not be affected by >

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Serhiy Storchaka
12.01.21 22:38, Julien Palard via Python-Dev пише: > During the development of cpython 3.10, Sphinx was bumped to 3.2.1. > > Problem is Sphinx 3 have some incompatibilities with Sphinx 2, some that > we could work around, some are bit harder, so we may need to bump > `needs_sphinx = '3.2'`

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Julien Palard via Python-Dev
Hi Matthias, Le 2021-01-13 à 12:27, Matthias Klose a écrit : > That's not true. Ubuntu 20.04 LTS still sees updates to subminor Python 3.8 > versions, having sphinx 1.8.5. I do agree to *not* bump our Sphinx dependencies for already published Pythons. Would it be OK to bump Sphinx to 3.2 for

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Julien Palard via Python-Dev
Le 2021-01-13 à 00:28, Victor Stinner a écrit : > Since documentation changes are backported to 3.8 and 3.9 stable > branches, if we increase the minimum required Sphinx version in > master, I would prefer to also increase it in 3.8 and 3.9 branches. Bumping a dependency on the next release is

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Julien Palard via Python-Dev
Le 2021-01-13 à 00:09, Senthil Kumaran a écrit : > Wouldn't this a bug with Sphinx? No, this is a documented breaking change between Sphinx 2 and Sphinx 3. > Why would that be special cased with a flag (strip_signature_backslash)? The strip_signature_backslash has been introduced to allow

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Ivan Pozdeev via Python-Dev
On 13.01.2021 3:12, Senthil Kumaran wrote: On Wed, Jan 13, 2021 at 02:53:30AM +0300, Ivan Pozdeev via Python-Dev wrote: I support keeping same Sphinx version across all the supported python versions. This is not a sustainable route since this way, there's no way to change the version at

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-13 Thread Matthias Klose
On 1/13/21 12:28 AM, Victor Stinner wrote: > Since documentation changes are backported to 3.8 and 3.9 stable > branches, if we increase the minimum required Sphinx version in > master, I would prefer to also increase it in 3.8 and 3.9 branches. > > I would prefer to not have to check manually if

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-12 Thread Senthil Kumaran
On Wed, Jan 13, 2021 at 02:53:30AM +0300, Ivan Pozdeev via Python-Dev wrote: > > I support keeping same Sphinx version across all the supported python > > versions. > > This is not a sustainable route since this way, there's no way to change the > version at all. > By supported, I mean the

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-12 Thread Ivan Pozdeev via Python-Dev
On 13.01.2021 2:47, Senthil Kumaran wrote: On Wed, Jan 13, 2021 at 12:28:42AM +0100, Victor Stinner wrote: The alternative is to keep Sphinx 2 support, use strip_signature_backslash and don't use :no-trim-doctest-flags: ? +1. :no-trim-doctest-flags: was introduced to python docs only

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-12 Thread Miro Hrončok
On 13. 01. 21 0:28, Victor Stinner wrote: I looked at Sphinx and Python versions of Debian, Ubuntu and Fedora: https://bugs.python.org/issue42843#msg384963 In my list, there is only Debian Buster (stable) which doesn't have Sphinx 3 yet. It uses Python 3.7 and so would not be affected by Python

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-12 Thread Senthil Kumaran
On Wed, Jan 13, 2021 at 12:28:42AM +0100, Victor Stinner wrote: > The alternative is to keep Sphinx 2 support, use > strip_signature_backslash and don't use :no-trim-doctest-flags: ? +1. :no-trim-doctest-flags: was introduced to python docs only recently, so not using that is a reasonable

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-12 Thread Victor Stinner
Since documentation changes are backported to 3.8 and 3.9 stable branches, if we increase the minimum required Sphinx version in master, I would prefer to also increase it in 3.8 and 3.9 branches. I would prefer to not have to check manually if a doc backport PR is still compatible with Sphinx 2

[Python-Dev] Re: Bumping minimum Sphinx version to 3.2 for cpython 3.10?

2021-01-12 Thread Senthil Kumaran
On Tue, Jan 12, 2021 at 08:38:17PM +, Julien Palard via Python-Dev wrote: > - Some functions declarations are lacking a backslash, like >print(*objects, sep=' ', end='n', ... > > Which is bad. Wouldn't this a bug with Sphinx? Why would that be special cased with a flag