All of lore.kernel.org
 help / color / mirror / Atom feed
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>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	linux-input@vger.kernel.org
Subject: [PATCH RFC 07/11] input: docs: properly format ToC headings
Date: Fri, 27 Oct 2023 10:18:26 +0200	[thread overview]
Message-ID: <20231027081830.195056-8-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: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 Documentation/input/input_kapi.rst   | 5 +----
 Documentation/input/input_uapi.rst   | 5 +----
 Documentation/input/joydev/index.rst | 5 +----
 3 files changed, 3 insertions(+), 12 deletions(-)

diff --git a/Documentation/input/input_kapi.rst b/Documentation/input/input_kapi.rst
index 41f1b7e6b78e..9937522daa9b 100644
--- a/Documentation/input/input_kapi.rst
+++ b/Documentation/input/input_kapi.rst
@@ -4,11 +4,8 @@
 Linux Input Subsystem kernel API
 ################################
 
-.. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+   :caption: Table of Contents
    :maxdepth: 2
    :numbered:
 
diff --git a/Documentation/input/input_uapi.rst b/Documentation/input/input_uapi.rst
index 4a0391609327..8275b4223a84 100644
--- a/Documentation/input/input_uapi.rst
+++ b/Documentation/input/input_uapi.rst
@@ -4,11 +4,8 @@
 Linux Input Subsystem userspace API
 ###################################
 
-.. class:: toc-title
-
-        Table of Contents
-
 .. toctree::
+   :caption: Table of Contents
    :maxdepth: 2
    :numbered:
 
diff --git a/Documentation/input/joydev/index.rst b/Documentation/input/joydev/index.rst
index ebcff43056e2..d03d6f6cbfab 100644
--- a/Documentation/input/joydev/index.rst
+++ b/Documentation/input/joydev/index.rst
@@ -6,11 +6,8 @@ Linux Joystick support
 
 :Copyright: |copy| 1996-2000 Vojtech Pavlik <vojtech@ucw.cz> - Sponsored by SuSE
 
-.. class:: toc-title
-
-	Table of Contents
-
 .. toctree::
+	:caption: Table of Contents
 	:maxdepth: 3
 
 	joystick
-- 
2.34.1


  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 ` [PATCH RFC 05/11] Documentation: dev-tools: properly format ToC headingss Vegard Nossum
2023-10-27  8:18 ` [PATCH RFC 06/11] docs: driver-api: properly format ToC headings Vegard Nossum
2023-10-27  8:18 ` Vegard Nossum [this message]
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-8-vegard.nossum@oracle.com \
    --to=vegard.nossum@oracle.com \
    --cc=corbet@lwn.net \
    --cc=dmitry.torokhov@gmail.com \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    /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.