2023-10-27 08:19:56

by Vegard Nossum

[permalink] [raw]
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 <[email protected]>
Cc: gaochao <[email protected]>
Cc: Yanteng Si <[email protected]>
Cc: Wu XiangCheng <[email protected]>
Cc: Fangrui Song <[email protected]>
Cc: Wan Jiabing <[email protected]>
Cc: Alex Shi <[email protected]>
Signed-off-by: Vegard Nossum <[email protected]>
---
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