Skip to contentSkip to conversation

Documentation: sphinx: Require alabaster <0.7.14

PATCH In review Bagas Sanjaya 2 participants 3 messages Jan 11, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: sphinx: Require alabaster <0.7.14

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).

---
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(+)
Documentation/sphinx/requirements.txt +2 -0
index 335b53df35e22f..b2ca7432437518 100644
@@ -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

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw
Quoted 34 lines · Bagas Sanjaya

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).

---
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(+)
Documentation/sphinx/requirements.txt +2 -0
index 335b53df35e22f..b2ca7432437518 100644
@@ -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
Quoted 1 line

base-commit: de927f6c0b07d9e698416c5b287c521b07694cac

Note: I submitted almost exactly the same patch yesterday:

https://lore.kernel.org/linux-doc/[email protected]/

Vegard

#2 lore raw
Quoted 35 lines · Vegard Nossum
Quoted 34 lines · Bagas Sanjaya

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).

---
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(+)
Documentation/sphinx/requirements.txt +2 -0
index 335b53df35e22f..b2ca7432437518 100644
@@ -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
Quoted 6 lines
Quoted 1 line

base-commit: de927f6c0b07d9e698416c5b287c521b07694cac

Note: I submitted almost exactly the same patch yesterday:

https://lore.kernel.org/linux-doc/[email protected]/

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

Signature · 1 line
An old man doll... just what I always wanted! - Clara