Hi Jon: Any update? Did you have a chance to check and comment on below? Best Regards! Ming Wen (闻明) SDK Team | Ambarella Shanghai -----Original Message----- From: Ming Wen Sent: Wednesday, April 30, 2025 11:16 PM To: Jonathan Corbet <corbet@xxxxxxx>; linux-doc@xxxxxxxxxxxxxxx Cc: mchehab@xxxxxxxxxx; Long Li <longli@xxxxxxxxxxxxx>; Jian Tang <jtang@xxxxxxxxxxxxx>; Zhao-Yang Chen <zychen@xxxxxxxxxxxxx>; Rongrong Cao <rrcao@xxxxxxxxxxxxx> Subject: RE: [EXT] Re: [Kernel 5.15/Kernle 6.1] About Sphinx Doc. Importance: Low Hi Jon: Perfect! Thanks for the quick trying. When you built for 6.134 using Sphinx 7.3.7, did you have a chance to check the output of Sphinx doc? How about the web GUI? Does it look well with the expected decoration? At our side, we can build the Sphinx doc successfully(although also with a lot of warning like you saw) if using Sphinx 8.1.3. But when looking at the web GUI, it is not right. The decoration is missing and the web link layout is also not good. $ linux-5.15/Documentation/output/index.html If we switch back to Sphinx 2.4.4 following below method with extra dependencies added in requirements.txt, we can get the perfect web GUI decoration and layout. $ /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 (闻明) SDK Team | Ambarella Shanghai -----Original Message----- From: Jonathan Corbet <corbet@xxxxxxx> Sent: Wednesday, April 30, 2025 10:06 PM To: Ming Wen <mwen@xxxxxxxxxxxxx>; linux-doc@xxxxxxxxxxxxxxx Cc: mchehab@xxxxxxxxxx; Long Li <longli@xxxxxxxxxxxxx>; Jian Tang <jtang@xxxxxxxxxxxxx>; Zhao-Yang Chen <zychen@xxxxxxxxxxxxx>; Rongrong Cao <rrcao@xxxxxxxxxxxxx> Subject: RE: [EXT] Re: [Kernel 5.15/Kernle 6.1] About Sphinx Doc. Ming Wen <mwen@xxxxxxxxxxxxx> writes: >> 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. > [Ming] To build the sphinx doc for Kernel 5.15 or 6.1, it is required to go with Sphinx 2.4.4. We recommended that version back then, mostly because the newer versions were slower, but it is absolutely not required. I just did the build for 6.134 using Sphinx 7.3.7. It emits a bunch of deprecation warnings, but otherwise works. There are various fixes in mainline for some of those warnings; somebody could certainly pick them out and ask for stable backports. I can put that onto my list of things to do, but won't get there in the next few days. Thanks, jon ********************************************************************** 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.
