Re: [PATCH RFC] docs: Add more information to the HTML sidebar

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

 



Hi all,

On Fri, 20 Jan 2023 19:08:14 +0530, Sadiya Kazi wrote:
> On Fri, Jan 20, 2023 at 5:41 AM Jonathan Corbet <corbet@xxxxxxx> 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.
>>
>> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
>> ---
> Thank you, Jon.
> 
> This is definitely an improvement as we are able to see the second
> level headings in the
> sidebar of the main page. But I would still prefer the "RTD" theme
> kind of sidebar due to the
> following reasons:
> - This sidebar toc list is not bulleted and the same chapter name runs
> into multiple lines making
>    it trickier for the reader to click the exact chapter they are interested in.
>    Perhaps this can be handled by increasing the width of the sidebar.
> This will avoid the
>    chapter headings to go to the next line.
> - Comprehending "where am I" is difficult. When I use the table of
> contents to navigate
>   to any chapter, such as https://static.lwn.net/kerneldoc/dev-
> tools/kunit/architecture.html,
>   I'm unsure of where to go from here because it's difficult to find
> this chapter's exact location
>   in the table of contents. Is there a way to get the nested headings
> in the sidebar until
>   depth 3 and make it collapsible?

I have mostly the same list of possible improvements.

As for the "where am I?" syndrome, it would be helpful if the sidebar
could be scrolled independently.

I'd really like to suggest some code changes, but unable to do so.

> 
> Regards,
> Sadiya
> 
> 
> 
> 
> 
>> So this is just a first attempt to create a more crowded sidebar; the
>> result is somewhat like what RTD does; I'm not hugely happy with it, but
>> it's a start.
>>
>> I've put a copy of the rendered docs at:
>>
>>   https://static.lwn.net/kerneldoc/
>>
>> Thoughts?  Is this headed in the right direction?  This view of the TOC
>> is readily available from Sphinx; if we want something else it's going
>> to be rather more work.

I think this looks like the right direction. But how far do you want to
mimic RTD's sidebar???

        Thanks, Akira




[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