[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <87ila9atuk.fsf@meer.lwn.net>
Date: Mon, 24 Jul 2023 15:21:39 -0600
From: Jonathan Corbet <corbet@....net>
To: Costa Shulyupin <costa.shul@...hat.com>,
Miguel Ojeda <ojeda@...nel.org>,
Alex Gaynor <alex.gaynor@...il.com>,
Wedson Almeida Filho <wedsonaf@...il.com>,
Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>,
Björn Roy Baron <bjorn3_gh@...tonmail.com>,
Benno Lossin <benno.lossin@...ton.me>,
"open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
open list <linux-kernel@...r.kernel.org>,
"open list:DOCUMENTATION PROCESS" <workflows@...r.kernel.org>,
"open list:RUST" <rust-for-linux@...r.kernel.org>
Cc: Costa Shulyupin <costa.shul@...hat.com>
Subject: Re: [RFC PATCH] rework top page and organize toc on the sidebar
Costa Shulyupin <costa.shul@...hat.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
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.
jon
Powered by blists - more mailing lists