Hi Jon: Thanks for the quick response. And well noted for your highlights. > We’re now working on LTS Kernel 5.15 and 6.1. Recently, we’re trying > to build their Sphinx Doc. [Ming] Although they are old, they are still LTS versions. 😊 > 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. Below is the python requirements.txt included in Kernel 5.15 and 6.1 $ 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 > Current Sphinx works fine, as far as I know; are there specific problems that you can report with current kernels? [Ming] Could you give a try by building the sphinx doc for kernel 5.15 or kernel 6.1 using the default version Sphinx(like 8.1.3 ) on ubuntu 22.04 or 24.04? I believe you will find surprise. 😊 > Again, those are very old kernels, that you are trying to make work with a very old version of Sphinx. I'm not sure why those patches would be useful to anybody else? [Ming] I definitely want to try with the latest Sphinx tool. But the kernel 5.15 or 6.1 requires us to use 2.4.4, which you think is a very old version of Sphinx. We actually tried Sphinx 8.1.3 to build it for kernel 5.15 or 6.1. The output is not right (no proper decoration on the web GUI). > 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. [Ming] Just checked with our IT members to get rid of it. Let me know if you still can see it. Best Regards! Ming Wen (闻明) SDK Team | Ambarella Shanghai -----Original Message----- From: Jonathan Corbet <corbet@xxxxxxx> Sent: Wednesday, April 30, 2025 8:47 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: [EXT] Re: [Kernel 5.15/Kernle 6.1] About Sphinx Doc. Ming Wen <mwen@xxxxxxxxxxxxx> writes: > Dear Linux Doc’ers: > > Nice to e-meet you! And thanks for your great contribution to Linux > Kernel world as always. 😊 To begin with, please do not send HTML mail, it won't make it through to the lists. > We’re now working on LTS Kernel 5.15 and 6.1. Recently, we’re trying > to build their Sphinx Doc. These are, of course, quite old kernels. > 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. Required by who? That is an ancient version of Sphinx at this point. > 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). Current Sphinx works fine, as far as I know; are there specific problems that you can report with current kernels? > 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(highlighted below in yellow) 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. Again, those are very old kernels, that you are trying to make work with a very old version of Sphinx. I'm not sure why those patches would be useful to anybody else? > 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. This, too, is not appropriate to send within our development community. Thanks, jon ###################################################################### This EXTERNAL email has been scanned by Proofpoint Email Protect service. ********************************************************************** 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.
