Dear Linux Doc’ers: Nice to e-meet you! And thanks for your great contribution to Linux Kernel world as always. 😊 We’re now working on LTS Kernel 5.15 and 6.1. Recently, we’re trying to build their Sphinx Doc. It is required to go with Sphinx 2.4.4, which is much lower than the version(8.1.3) of ubuntu 22.04 and 24.04. PS: if going with very new version of Sphinx like 8.1.3, the final output is not right(doesn’t have the proper decoration). $ cat Documentation/sphinx/requirements.txt # jinja2>=3.1 is not compatible with Sphinx<4.0 jinja2<3.1 sphinx_rtd_theme Sphinx==2.4.4 To try to resolve this, we followed below way to build kernel Sphinx Doc by having Sphinx to stay with 2.4.4. However, it will require extra dependency packages(listed in below diff) before we can build the doc properly. Here, we’d like to check with your comments for whether it will be good to merge it into the main branch for Kernel 5.15 and 6.1. If not, do you have any concern on this? Or you have other better options/advices for us to try? Thanks again for your time. $ /usr/bin/python3 -m venv sphinx_2.4.4 $ . sphinx_2.4.4/bin/activate $ pip install -r ./Documentation/sphinx/requirements.txt https://lore.kernel.org/lkml/50045aff-91f9-4809-ba3e-b722b325d233@xxxxxxxxxx/T/ https://lore.kernel.org/lkml/20240226093854.47830-1-lukas.bulwahn@xxxxxxxxx/T/ diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt index 2c573541ab712..6e7ed641747f7 100644 --- a/Documentation/sphinx/requirements.txt +++ b/Documentation/sphinx/requirements.txt @@ -1,4 +1,10 @@ # jinja2>=3.1 is not compatible with Sphinx<4.0 jinja2<3.1 sphinx_rtd_theme +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 Best Regards! Ming Wen (闻明) Ambarella Shanghai ********************************************************************** This email and attachments contain Ambarella Proprietary and/or Confidential Information and is intended solely for the use of the individual(s) to whom it is addressed. Any unauthorized review, use, disclosure, distribute, copy, or print is prohibited. If you are not an intended recipient, please contact the sender by reply email and destroy all copies of the original message. Thank you.
