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/[email protected]/
Reported-by: Akira Yokosawa <[email protected]>
Closes: https://lore.kernel.org/linux-doc/[email protected]/
Suggested-by: Jani Nikula <[email protected]>
Signed-off-by: Lukas Bulwahn <[email protected]>
---
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