From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4F7AAC0015E for ; Mon, 24 Jul 2023 21:21:49 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231152AbjGXVVs (ORCPT ); Mon, 24 Jul 2023 17:21:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54812 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231145AbjGXVVq (ORCPT ); Mon, 24 Jul 2023 17:21:46 -0400 Received: from ms.lwn.net (ms.lwn.net [IPv6:2600:3c01:e000:3a1::42]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D57AB1737; Mon, 24 Jul 2023 14:21:40 -0700 (PDT) Received: from localhost (unknown [IPv6:2601:281:8300:73::5f6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 1603A733; Mon, 24 Jul 2023 21:21:40 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 1603A733 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1690233700; bh=gaNKVqyvP22L4mM+8WXVkl4QkXFivhR0y8i1kXszzPQ=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=Imyn4jnOBa86K/OaOKITI/KBfz9yvh0y9ALfYriy5qxu4LN+yV24qqe3iRsQWGXet Z0x30JO9siMaPYMDEly+xc1qoNp45ZaUQ1D85j9tUoC6C5NVbGLODqkfajJaPYXs0N KFT7VVC9eI8oduNvf/yvbgOi9hQ5JCJuSm9uDzMiQMhkAigNV1uBCRBERqqny9mtXY VcQdMGxkwxZcXHjLPVM7yP2kJyq7AqvEX51t1e0q6hb47Ba7f6fiodQUqvxe7mcXT2 a/TsUs0wUQQIY8VUy/Uurzj1/RQMIhvRoz77GY4o2+QyPG0ySzzrSOxjoLuOcPIxdP 3iGu6Y+qoYdXw== From: Jonathan Corbet To: Costa Shulyupin , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?Q?Bj=C3=B6rn?= Roy Baron , Benno Lossin , "open list:DOCUMENTATION" , open list , "open list:DOCUMENTATION PROCESS" , "open list:RUST" Cc: Costa Shulyupin Subject: Re: [RFC PATCH] rework top page and organize toc on the sidebar In-Reply-To: <20230724193118.2204673-1-costa.shul@redhat.com> References: <20230724193118.2204673-1-costa.shul@redhat.com> Date: Mon, 24 Jul 2023 15:21:39 -0600 Message-ID: <87ila9atuk.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Costa Shulyupin 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