media: doc: properly format ToC headings
authorVegard Nossum <vegard.nossum@oracle.com>
Fri, 27 Oct 2023 08:18:28 +0000 (10:18 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 17 Nov 2023 20:05:26 +0000 (13:05 -0700)
"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: linux-media@vger.kernel.org
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231027081830.195056-10-vegard.nossum@oracle.com
Documentation/userspace-api/media/cec/cec-api.rst
Documentation/userspace-api/media/drivers/index.rst
Documentation/userspace-api/media/dvb/dvbapi.rst
Documentation/userspace-api/media/index.rst
Documentation/userspace-api/media/mediactl/media-controller.rst
Documentation/userspace-api/media/rc/remote_controllers.rst
Documentation/userspace-api/media/v4l/v4l2.rst

index 4d229ed8a1d980e681be796ae8005366de59d138..578303d484f325761eea00bb50154e391ac316dd 100644 (file)
@@ -10,13 +10,8 @@ Part V - Consumer Electronics Control API
 This part describes the CEC: Consumer Electronics Control
 
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :maxdepth: 5
     :numbered:
 
index 6708d649afd75b21386566613fa9f89891c5a40b..d4338dc506dda8a640b1935ba1129fd241e149f3 100644 (file)
@@ -21,13 +21,8 @@ more details.
 
 For more details see the file COPYING in the source distribution of Linux.
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+       :caption: Table of Contents
        :maxdepth: 5
        :numbered:
 
index 1dda69343f34246493ad449e3970a449b18e216f..4ac0c1bc54ca6e30ebd5b5c2a52b2e2f001ec431 100644 (file)
@@ -27,13 +27,8 @@ Part II - Digital TV API
 
 **Version 5.10**
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :maxdepth: 5
     :numbered:
 
index d839904be08591ba57a36c74139fb0169f2e1957..337ef6c7c47f54fd856435032d670fbb1a30247d 100644 (file)
@@ -21,13 +21,8 @@ Documentation/driver-api/media/index.rst
     media devices;
 
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :maxdepth: 1
 
     intro
index 508dd693bf6c6a66e1669a24c0e93e7f9796308a..73a87f82f92dbcf43576ca314b31ace601a59e0d 100644 (file)
@@ -7,13 +7,8 @@
 Part IV - Media Controller API
 ##############################
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :maxdepth: 5
     :numbered:
 
index f89291838637ad64c256b38af2aa33dcd097902f..483f9ae92a906e7ed2ce57e8bf44d2a664d0e243 100644 (file)
@@ -7,13 +7,8 @@
 Part III - Remote Controller API
 ################################
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :maxdepth: 5
     :numbered:
 
index ad7a2bf0cf26c71a74a285b251f2e29704bb9715..cf8ae56a008c1f795aacb4067c2f1a356b370227 100644 (file)
@@ -11,13 +11,8 @@ This part describes the Video for Linux API version 2 (V4L2 API) specification.
 
 **Revision 4.5**
 
-.. only:: html
-
-   .. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+    :caption: Table of Contents
     :numbered:
     :maxdepth: 5