linux-kernel - [PATCH RFC 05/11] Documentation: dev-tools: properly format ToC headingss

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 27 Oct 2023 10:18:24 +0200
From:   Vegard Nossum <vegard.nossum@...cle.com>
To:     linux-doc@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Cc:     Jani Nikula <jani.nikula@...el.com>, linux-kernel@...r.kernel.org,
        Vegard Nossum <vegard.nossum@...cle.com>,
        gaochao <gaochao49@...wei.com>,
        Yanteng Si <siyanteng@...ngson.cn>,
        Wu XiangCheng <bobwxc@...il.cn>,
        Fangrui Song <maskray@...gle.com>,
        Wan Jiabing <wanjiabing@...o.com>, Alex Shi <alexs@...nel.org>
Subject: [PATCH RFC 05/11] Documentation: dev-tools: properly format ToC headingss

"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@...nel.org>
Cc: gaochao <gaochao49@...wei.com>
Cc: Yanteng Si <siyanteng@...ngson.cn>
Cc: Wu XiangCheng <bobwxc@...il.cn>
Cc: Fangrui Song <maskray@...gle.com>
Cc: Wan Jiabing <wanjiabing@...o.com>
Cc: Alex Shi <alexs@...nel.org>
Signed-off-by: Vegard Nossum <vegard.nossum@...cle.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