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

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

 



On Fri, 20 Jan 2023 08:19:02 -0700, Jonathan Corbet wrote:
> Akira Yokosawa <akiyks@xxxxxxxxx> writes:
> 
>>>> 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???
> 
> Well ... that is kind of my question for all of the folks who are
> unhappy with the current sidebar.  What would you like to see there?
> 
> Things like sidebar width, whether bullets are used (I'd deliberately
> taken them out as excess noise), which text is which color, etc. are all
> just CSS; we can paint that shed any color we like.  The harder part is
> deciding which information we want to have there in the first place.  So
> ... is the set of links shown in the new sidebar close to what we
> want...  too much stuff?  Something missing?

Seeing no response from anyone so far, I feel like I need to express
my personal view. As you might already be well aware of, I love the
site navigation of RTD both on large screens and small (narrow) screens.

On *what* should be in the sidebar, I don't see anything missing
give or take the toctree depth.

To my eyes, there is two deficiencies with the alabaster theme in site
navigation.

  - Even with this RFC patch amended with the diff I suggested in
    https://lore.kernel.org/linux-doc/6b2e496f-d7f6-abea-6bbd-4b12fea76a68@xxxxxxxxx/,
    there remain "Where am I???" moments when jumping to a different page.
    In such jumps, alabaster's sidebar always reset to top with the
    main pane. RTD's sidebar keeps its position so there is no such
    moment.

  - On small/narrow screens, alabaster's sidebar is pushed downward
    to the bottom of the page. This means you typically need three
    steps to see where you are when jumping to another page:

      1) Jump to another page.
      2) Scroll to the bottom.
      3) See where you are.

    With RTD, you don't need to scroll to the bottom. Sidebar is there
    behind an icon at the top-left which is often used as "menu" icon.

      1) Jump to another page.
      2) Open sidebar and it tells you where you are.

I don't know if alabaster can be managed to behave similar to RTD
with a reasonable effort.

        Thanks, Akira


> 
> Thanks,
> 
> jon



[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