lkml.org 
[lkml]   [2023]   [Oct]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH RFC 09/11] media: doc: properly format ToC headings
    Date
    "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>
    ---
    Documentation/userspace-api/media/cec/cec-api.rst | 7 +------
    Documentation/userspace-api/media/drivers/index.rst | 7 +------
    Documentation/userspace-api/media/dvb/dvbapi.rst | 7 +------
    Documentation/userspace-api/media/index.rst | 7 +------
    .../userspace-api/media/mediactl/media-controller.rst | 7 +------
    .../userspace-api/media/rc/remote_controllers.rst | 7 +------
    Documentation/userspace-api/media/v4l/v4l2.rst | 7 +------
    7 files changed, 7 insertions(+), 42 deletions(-)

    diff --git a/Documentation/userspace-api/media/cec/cec-api.rst b/Documentation/userspace-api/media/cec/cec-api.rst
    index 4d229ed8a1d9..578303d484f3 100644
    --- a/Documentation/userspace-api/media/cec/cec-api.rst
    +++ b/Documentation/userspace-api/media/cec/cec-api.rst
    @@ -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:

    diff --git a/Documentation/userspace-api/media/drivers/index.rst b/Documentation/userspace-api/media/drivers/index.rst
    index 6708d649afd7..d4338dc506dd 100644
    --- a/Documentation/userspace-api/media/drivers/index.rst
    +++ b/Documentation/userspace-api/media/drivers/index.rst
    @@ -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:

    diff --git a/Documentation/userspace-api/media/dvb/dvbapi.rst b/Documentation/userspace-api/media/dvb/dvbapi.rst
    index 1dda69343f34..4ac0c1bc54ca 100644
    --- a/Documentation/userspace-api/media/dvb/dvbapi.rst
    +++ b/Documentation/userspace-api/media/dvb/dvbapi.rst
    @@ -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:

    diff --git a/Documentation/userspace-api/media/index.rst b/Documentation/userspace-api/media/index.rst
    index d839904be085..337ef6c7c47f 100644
    --- a/Documentation/userspace-api/media/index.rst
    +++ b/Documentation/userspace-api/media/index.rst
    @@ -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
    diff --git a/Documentation/userspace-api/media/mediactl/media-controller.rst b/Documentation/userspace-api/media/mediactl/media-controller.rst
    index 508dd693bf6c..73a87f82f92d 100644
    --- a/Documentation/userspace-api/media/mediactl/media-controller.rst
    +++ b/Documentation/userspace-api/media/mediactl/media-controller.rst
    @@ -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:

    diff --git a/Documentation/userspace-api/media/rc/remote_controllers.rst b/Documentation/userspace-api/media/rc/remote_controllers.rst
    index f89291838637..483f9ae92a90 100644
    --- a/Documentation/userspace-api/media/rc/remote_controllers.rst
    +++ b/Documentation/userspace-api/media/rc/remote_controllers.rst
    @@ -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:

    diff --git a/Documentation/userspace-api/media/v4l/v4l2.rst b/Documentation/userspace-api/media/v4l/v4l2.rst
    index ad7a2bf0cf26..cf8ae56a008c 100644
    --- a/Documentation/userspace-api/media/v4l/v4l2.rst
    +++ b/Documentation/userspace-api/media/v4l/v4l2.rst
    @@ -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

    --
    2.34.1
    \
     
     \ /
      Last update: 2023-10-27 10:19    [W:3.337 / U:1.076 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site