Re: [PATCH] Documentation: sphinx: Require alabaster <0.7.14

Bagas Sanjaya
2024-01-11T14:04:39Z

[-- Attachment #1: Type: text/plain, Size: 1938 bytes --]

On Thu, Jan 11, 2024 at 12:18:44PM +0100, Vegard Nossum wrote:
> On 11/01/2024 11:21, Bagas Sanjaya wrote:
> > Alabaster commit 640273fd3ca7 ("Drop support for Python 3.8 and
> > earlier") [1] bumps minimum Sphinx version to v3.4, which breaks
> > htmldocs build due to version incompatibility with Sphinx version used
> > in Linux kernel documentation (v2.4.4):
> >
> > ```
> > Sphinx version error:
> > The alabaster extension used by this project needs at least Sphinx v3.4; it therefore cannot be built with this version.
> > ```
> >
> > Fix the build error by requiring alabaster version less than 0.7.14 (in
> > other words, at most 0.7.13).
> >
> > Link: https://github.com/sphinx-doc/alabaster/commit/640273fd3ca7cdc1528c591172fd9cce2ead911c [1]
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> > ---
> > I'm noticing htmldocs error when trying to build current master (still in
> > merge window). Is this patch OK for 6.8 material after v6.8-rc1 is released
> > (as stabilizing fix)?
> >
> > Documentation/sphinx/requirements.txt | 2 ++
> > 1 file changed, 2 insertions(+)
> >
> > diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
> > index 335b53df35e22f..b2ca7432437518 100644
> > --- a/Documentation/sphinx/requirements.txt
> > +++ b/Documentation/sphinx/requirements.txt
> > @@ -1,3 +1,5 @@
> > # jinja2>=3.1 is not compatible with Sphinx<4.0
> > jinja2<3.1
> > Sphinx==2.4.4
> > +# alabaster>=0.7.14 is not compatible with Sphinx<3.4
> > +alabaster<0.7.14
> >
> > base-commit: de927f6c0b07d9e698416c5b287c521b07694cac
>
> Note: I submitted almost exactly the same patch yesterday:
>
> https://lore.kernel.org/linux-doc/20240110104646.3647600-1-vegard.nossum@oracle.com/
>

Oops, I didn't see your patch before I submitted mine. Thanks anyway.

--
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]