* [PATCH] docs: freeze some package versions for sphinx virtualenv setup
@ 2024-02-26 9:38 Lukas Bulwahn
0 siblings, 0 replies; only message in thread
From: Lukas Bulwahn @ 2024-02-26 9:38 UTC (permalink / raw)
To: Jonathan Corbet, Akira Yokosawa, Jani Nikula, linux-doc,
Vegard Nossum, Mauro Carvalho Chehab
Cc: kernel-janitors, linux-kernel, Lukas Bulwahn
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
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2024-02-26 9:39 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-26 9:38 [PATCH] docs: freeze some package versions for sphinx virtualenv setup Lukas Bulwahn
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).