Re: [PATCH] docs: sphinx/requirements: Limit jinja2<3.1

From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: sphinx/requirements: Limit jinja2<3.1
Date: Tue, 29 Mar 2022 23:08:32 +0900	[thread overview]
Message-ID: <3cf78b3e-3336-b0fa-6f2f-5b4e64c73302@gmail.com> (raw)
In-Reply-To: <87ee2k7t9m.fsf@meer.lwn.net>

On Tue, 29 Mar 2022 08:00:53 -0600,
Jonathan Corbet wrote:
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
>> On 29/03/22 13.07, Akira Yokosawa wrote:
>>> diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
>>> index 9a35f50798a6..2c573541ab71 100644
>>> --- a/Documentation/sphinx/requirements.txt
>>> +++ b/Documentation/sphinx/requirements.txt
>>> @@ -1,2 +1,4 @@
>>> +# jinja2>=3.1 is not compatible with Sphinx<4.0
>>> +jinja2<3.1
>>>   sphinx_rtd_theme
>>>   Sphinx==2.4.4
>>>
>>
>> I see that we had already pinned the exact Sphinx version to 2.4.4 (or am
>> I read the requirements wrong?), so this only matters when people use Sphinx
>> from distribution packages, rather than using virtualenv as recommended.
> 
> We have been suggesting 2.4.4 simply because it's much faster than the
> later releases, but it's not a requirement.

There was a time when Sphinx 3.x.x was memory hungry and slower than 2.4.4.
Nowadays, Sphinx 4.x.x is getting much better and actually is much faster
than 2.4.4 in my experience.  Might depend on the underlying Python
release, though.

Sphinx 4.5.0 released yesterday works just fine.

        Thanks, Akira

> 
> Thanks,
> 
> jon