Messages in this thread | | | From | Jonathan Corbet <> | Subject | Re: [RFC PATCH] rework top page and organize toc on the sidebar | Date | Mon, 24 Jul 2023 15:21:39 -0600 |
| |
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
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
| |