Re: [PATCH v3] docs: improve the HTML sidebar/TOC

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

 



Hi Jon,

On Mon, 06 Feb 2023 12:30:02 -0700, Jonathan Corbet wrote:
> Add a new sidebar template that creates a more RTD-like "fisheye" view of
> the current place in the document hierarchy.  It is far from ideal, but
> some readers may find it better for navigating through the documentation as
> a whole.
> 
> Add some CSS trickery as well to make the table of contents less intrusive
> when viewing the pages on a small screen.
> 
> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
> ---
> Changes this time are almost entirely in the small-screen view; I've
> added some CSS trickery to hide the TOC by default so it doesn't get
> between readers and what they actually want to see.  I'm sure it could
> be done more elegantly, but my fluency with CSS ... does not afford much
> elegance ...
> 
> Once again, the results are at:
> 
>   https://static.lwn.net/kerneldoc/

It took a few seconds for me to figure out the TOC entries are hidden
behind the "[Show]". Yes, this works reasonably well.

Thank you for your efforts.

Reviewed-by: Akira Yokosawa <akiyks@xxxxxxxxx>

        Thanks, Akira 

> 
> This is as far as this work is likely to get before the merge window; in
> the absence of screams, I'll drop it into linux-next in the near future.
> 
>  Documentation/conf.py                         |  5 +-
>  Documentation/sphinx-static/custom.css        | 48 ++++++++++++++++++-
>  .../sphinx/templates/kernel-toc.html          | 15 ++++++
>  3 files changed, 65 insertions(+), 3 deletions(-)
>  create mode 100644 Documentation/sphinx/templates/kernel-toc.html
> 




[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