From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
Akira Yokosawa <akiyks@gmail.com>,
Jani Nikula <jani.nikula@linux.intel.com>,
linux-doc@vger.kernel.org,
Vegard Nossum <vegard.nossum@oracle.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: [PATCH] docs: freeze some package versions for sphinx virtualenv setup
Date: Mon, 26 Feb 2024 10:38:54 +0100 [thread overview]
Message-ID: <20240226093854.47830-1-lukas.bulwahn@gmail.com> (raw)
If you currently follow the instructions for sphinx install:
/usr/bin/python3 -m venv sphinx_2.4.4
. sphinx_2.4.4/bin/activate
pip install -r ./Documentation/sphinx/requirements.txt
you encounter an error during make htmldocs:
Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs
at least Sphinx v5.0; it therefore cannot be built with this version.
Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
was fast in providing a fix (see Link). This however remained as a thread
on the linux-doc mailing and was never turned into a patch for Jonathan to
pick up.
Fix some versions for the Sphinx 2.4.4 to continue to work.
Link: https://lore.kernel.org/linux-doc/cb72b3d6-de7a-4c8a-a99c-72d58a23f89c@gmail.com/
Reported-by: Akira Yokosawa <akiyks@gmail.com>
Closes: https://lore.kernel.org/linux-doc/cb72b3d6-de7a-4c8a-a99c-72d58a23f89c@gmail.com/
Suggested-by: Jani Nikula <jani.nikula@linux.intel.com>
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Documentation/sphinx/requirements.txt | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 5d47ed443949..0aa4fdb84632 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -2,5 +2,10 @@
jinja2<3.1
# alabaster>=0.7.14 is not compatible with Sphinx<=3.3
alabaster<0.7.14
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
Sphinx==2.4.4
pyyaml
--
2.43.2
next reply other threads:[~2024-02-26 9:39 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-26 9:38 Lukas Bulwahn [this message]
2024-02-27 6:56 ` [PATCH] docs: freeze some package versions for sphinx virtualenv setup Akira Yokosawa
2024-02-27 8:24 ` Lukas Bulwahn
2024-02-27 8:40 ` Vegard Nossum
2024-02-27 13:17 ` Lukas Bulwahn
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=20240226093854.47830-1-lukas.bulwahn@gmail.com \
--to=lukas.bulwahn@gmail.com \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@kernel.org \
--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).