lkml.org 
[lkml]   [2023]   [Jul]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    SubjectRe: [RFC PATCH] rework top page and organize toc on the sidebar
    From


    On 7/24/23 14:21, Jonathan Corbet wrote:
    > Costa Shulyupin <costa.shul@redhat.com> writes:
    >
    >> Template {{ toctree(maxdepth=3) }} in
    >> Documentation/sphinx/templates/kernel-toc.html
    >> uses directives toctree and doesn't use sections on the top page
    >> Documentation/index.rst
    >> to generate expandable toc on the sidebar.
    >>
    >> BTW, other template {{ toc }} uses only sections, and doesn't
    >> use directives toctree.
    >>
    >> Summary of changes:
    >> - split top page index.rst to several pages
    >> - convert sections of Documentation/index.rst to hierarchical toctree
    >> - vertical bars '|' add empty lines
    >>
    >> Benefits:
    >> - collapsed toc is just seven short lines length
    >> - toc is expandable
    >>
    >> References:
    >> - https://www.sphinx-doc.org/en/master/development/templating.html#toctree
    >> - https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree
    >> - https://www.sphinx-doc.org/en/master/development/templating.html#toc
    >> - https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections
    >> - https://sphinx-rtd-theme.readthedocs.io/
    >
    > What is the purpose of all these links in a patch changelog?
    >
    > This patch is somewhat difficult to apply, as a result of:
    >
    >> Content-Type: text/plain; charset=true

    I didn't have any problem applying and testing it.

    > But the real problem is that you seem to have ignored my last message.
    > The purpose of the front page isn't to create a nice-looking sidebar, it
    > is the entry point to our documentation as a whole. I am all for a
    > better sidebar, but this is not the way to do it.

    Regardless of what the purpose of the front page is, I prefer this one
    from Costa. The other one is a huge mess.

    --
    ~Randy

    \
     
     \ /
      Last update: 2023-07-25 05:06    [W:4.011 / U:0.180 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site