From: Vegard Nossum <vegard.nossum@oracle.com>
To: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Jani Nikula <jani.nikula@intel.com>,
linux-kernel@vger.kernel.org,
Vegard Nossum <vegard.nossum@oracle.com>,
gaochao <gaochao49@huawei.com>,
Yanteng Si <siyanteng@loongson.cn>,
Wu XiangCheng <bobwxc@email.cn>,
Fangrui Song <maskray@google.com>,
Wan Jiabing <wanjiabing@vivo.com>, Alex Shi <alexs@kernel.org>
Subject: [PATCH RFC 05/11] Documentation: dev-tools: properly format ToC headingss
Date: Fri, 27 Oct 2023 10:18:24 +0200 [thread overview]
Message-ID: <20231027081830.195056-6-vegard.nossum@oracle.com> (raw)
In-Reply-To: <20231027081830.195056-1-vegard.nossum@oracle.com>
"class:: toc-title" was a workaround for older Sphinx versions that are
no longer supported.
The canonical way to add a heading to the ToC is to use :caption:.
Do that.
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: gaochao <gaochao49@huawei.com>
Cc: Yanteng Si <siyanteng@loongson.cn>
Cc: Wu XiangCheng <bobwxc@email.cn>
Cc: Fangrui Song <maskray@google.com>
Cc: Wan Jiabing <wanjiabing@vivo.com>
Cc: Alex Shi <alexs@kernel.org>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
Documentation/dev-tools/index.rst | 5 +----
Documentation/translations/zh_CN/dev-tools/index.rst | 5 +----
2 files changed, 2 insertions(+), 8 deletions(-)
diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
index 6b0663075dc0..3d2286c683bc 100644
--- a/Documentation/dev-tools/index.rst
+++ b/Documentation/dev-tools/index.rst
@@ -10,11 +10,8 @@ whole; patches welcome!
A brief overview of testing-specific tools can be found in
Documentation/dev-tools/testing-overview.rst
-.. class:: toc-title
-
- Table of contents
-
.. toctree::
+ :caption: Table of contents
:maxdepth: 2
testing-overview
diff --git a/Documentation/translations/zh_CN/dev-tools/index.rst b/Documentation/translations/zh_CN/dev-tools/index.rst
index 02577c379007..c2db3e566b1b 100644
--- a/Documentation/translations/zh_CN/dev-tools/index.rst
+++ b/Documentation/translations/zh_CN/dev-tools/index.rst
@@ -14,11 +14,8 @@
有关测试专用工具的简要概述，参见
Documentation/translations/zh_CN/dev-tools/testing-overview.rst
-.. class:: toc-title
-
- 目录
-
.. toctree::
+ :caption: 目录
:maxdepth: 2
testing-overview
--
2.34.1
next prev parent reply other threads:[~2023-10-27 8:19 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-27 8:18 [PATCH RFC 00/11] use toctree :caption: for ToC headings Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 01/11] docs: style toctree captions as headings Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 02/11] doc: userspace-api: properly format ToC headings Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 03/11] media: admin-guide: properly format ToC heading Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 04/11] crypto: doc: properly format ToC headings Vegard Nossum
2023-10-27 8:18 ` Vegard Nossum [this message]
2023-10-27 8:18 ` [PATCH RFC 06/11] docs: driver-api: " Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 07/11] input: docs: " Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 08/11] doc: misc-device: properly format ToC heading Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 09/11] media: doc: properly format ToC headings Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 10/11] docs: use toctree :caption: and move introduction Vegard Nossum
2023-10-27 8:18 ` [PATCH RFC 11/11] docs: remove .toc-title class Vegard Nossum
2023-10-27 8:32 ` [PATCH RFC 00/11] use toctree :caption: for ToC headings Jani Nikula
2023-11-17 20:09 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231027081830.195056-6-vegard.nossum@oracle.com \
--to=vegard.nossum@oracle.com \
--cc=alexs@kernel.org \
--cc=bobwxc@email.cn \
--cc=corbet@lwn.net \
--cc=gaochao49@huawei.com \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maskray@google.com \
--cc=mchehab@kernel.org \
--cc=siyanteng@loongson.cn \
--cc=wanjiabing@vivo.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.