RE: [EXT] Re: [Kernel 5.15/Kernle 6.1] About Sphinx Doc.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Jon:
 
Thanks for taking care of this.
I double checked again 6.1.
You're right. Your commit was merged already. And it was later on refined a bit by "Mauro Carvalho Chehab ". In his new logic, it will fill html_css_files automatically by checking the existence of python module: sphinx_rtd_theme. While in our previous test, we didn't install it properly. Sorry about this false alarm.

Thanks again for all your contributions to Kernel Sphinx Doc maintenance. It is really helpful for us to learn kernel things.

commit fca7216bf53e7f1f4a8dba6af386d6faa7699fd6
Author: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
Date:   Tue Dec 7 10:52:59 2021 +0100

    docs: allow selecting a Sphinx theme

    Instead of having RTD as an almost mandatory theme, allow the
    user to select other themes via DOCS_THEME environment var.

    There's a catch, though: as the current theme override logic is
    dependent of the RTD theme, we need to move the code which
    adds the CSS overrides to be inside the RTD theme logic.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
    Link: https://lore.kernel.org/r/bd20adabfd428fd3cd0e69c2cf146aa354932936.1638870323.git.mchehab+huawei@xxxxxxxxxx
    Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>

commit d69dab7de208748ddf79143b39d98db55eee9b4a
Author: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
Date:   Sat Nov 27 10:14:49 2021 +0100

    docs: conf.py: fix support for Readthedocs v 1.0.0

    As described at:
            https://stackoverflow.com/questions/23211695/modifying-content-width-of-the-sphinx-theme-read-the-docs

    since Sphinx 1.8, the standard way to setup a custom theme is
    to use html_css_files. While using html_context is OK with RTD
    0.5.2, it doesn't work with 1.0.0, causing the theme to not load,
    producing a very weird html.

    Tested with:
            - Sphinx 1.7.9 + sphinx-rtd-theme 0.5.2
            - Sphinx 2.4.4 + sphinx-rtd-theme 0.5.2
            - Sphinx 2.4.4 + sphinx-rtd-theme 1.0.0
            - Sphinx 4.3.0 + sphinx-rtd-theme 1.0.0

    Reported-by: Hans Verkuil <hverkuil@xxxxxxxxx>
    Tested-by: Hans Verkuil <hverkuil@xxxxxxxxx>
    Reviewed-by: Laurent Pinchart <laurent.pinchart@xxxxxxxxxxxxxxxx>
    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
    Tested-by: Akira Yokosawa <akiyks@xxxxxxxxx>
    Link: https://lore.kernel.org/r/80009f0d17ea0840d81e7e16fff6e7677919fdfc.1638004294.git.mchehab+huawei@xxxxxxxxxx
    Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>

Best Regards!
Ming Wen (闻明)
SDK Team | Ambarella Shanghai


-----Original Message-----
From: Jonathan Corbet <corbet@xxxxxxx> 
Sent: Thursday, June 5, 2025 4:54 AM
To: Ming Wen <mwen@xxxxxxxxxxxxx>; Rongrong Cao <rrcao@xxxxxxxxxxxxx>; linux-doc@xxxxxxxxxxxxxxx
Cc: mchehab@xxxxxxxxxx; Long Li <longli@xxxxxxxxxxxxx>; Jian Tang <jtang@xxxxxxxxxxxxx>; Zhao-Yang Chen <zychen@xxxxxxxxxxxxx>
Subject: RE: [EXT] Re: [Kernel 5.15/Kernle 6.1] About Sphinx Doc.

Ming Wen <mwen@xxxxxxxxxxxxx> writes:

> Thanks for the update. Good to know!

> As the next, Jon may help to check a bit why this changelist is missed 
> to be merged into LTS Kernel 5.15 and even LTS Kernel 6.1. It should 
> definitely be needed.😊

So I have *finally* had a chance to take a look at this.  For 5.15, I can certainly ask that commit d69dab7de208 be backported (I'll note that anybody else can do that too).  BUT: that commit was applied to 5.16, so if there are problems with 6.1, they lie elsewhere.  That makes me suspect that this commit isn't the one we're looking for?

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.




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux