From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>,
Vegard Nossum <vegard.nossum@oracle.com>,
Attreyee M <tintinm2017@gmail.com>,
Adam Turner <9087854+aa-turner@users.noreply.github.com>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH] Documentation: sphinx: Require alabaster <0.7.14
Date: Thu, 11 Jan 2024 17:21:31 +0700 [thread overview]
Message-ID: <20240111102128.37192-4-bagasdotme@gmail.com> (raw)
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
--
An old man doll... just what I always wanted! - Clara
next reply other threads:[~2024-01-11 10:23 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-11 10:21 Bagas Sanjaya [this message]
2024-01-11 11:18 ` [PATCH] Documentation: sphinx: Require alabaster <0.7.14 Vegard Nossum
2024-01-11 14:04 ` Bagas Sanjaya
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240111102128.37192-4-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=9087854+aa-turner@users.noreply.github.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=tintinm2017@gmail.com \
--cc=vegard.nossum@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).