From nobody Wed Dec 17 11:32:15 2025 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id C8431C25B47 for ; Fri, 27 Oct 2023 08:19:52 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235284AbjJ0ITw (ORCPT ); Fri, 27 Oct 2023 04:19:52 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58572 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235221AbjJ0ITc (ORCPT ); Fri, 27 Oct 2023 04:19:32 -0400 Received: from mx0a-00069f02.pphosted.com (mx0a-00069f02.pphosted.com [205.220.165.32]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 06922D42; Fri, 27 Oct 2023 01:19:22 -0700 (PDT) Received: from pps.filterd (m0246627.ppops.net [127.0.0.1]) by mx0b-00069f02.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 39R5iCp5020795; Fri, 27 Oct 2023 08:19:01 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-type : content-transfer-encoding; s=corp-2023-03-30; bh=1pikA91vUTNV05//EH2EMfg5yCx5g71Zj4B5oU1dgV0=; b=jzYtVlJsH7AHD5Czyrz5o1kH1Kti08yoBSUPloSJCxOD5oSdafKtwEHMGrEetRVo6H5U 3R2WtZ19Ar4xncHO4/X3NMx8HLiiC9lwX7/FyntzrxcTkbkJWyHg32buQjea61C25lnt +pcvUDPAguIFz9Km1GTrxGFrEHIjBoamzZDskUvV+EmcGUnjJyvp8JjRT/hhY8ZCVZYT 7j4r6SejUjOFwJ3HzLOZ36EvdXt6quUFdwMPgFkWSc6QjQ4h7lbHNy8fyl43cUwOA8XP us9HTuZWiiEZJ2Fno7vorfjna9i9zpSew4cv4zx/iZmgNoLx6CibK7AT3Mvxqeer+lH0 PA== Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.appoci.oracle.com [138.1.37.129]) by mx0b-00069f02.pphosted.com (PPS) with ESMTPS id 3tyx4tgx0j-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:19:01 +0000 Received: from pps.filterd (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (8.17.1.19/8.17.1.19) with ESMTP id 39R8FtVl009374; Fri, 27 Oct 2023 08:19:00 GMT Received: from pps.reinject (localhost [127.0.0.1]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTPS id 3tywqjebch-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 27 Oct 2023 08:19:00 +0000 Received: from phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com [127.0.0.1]) by pps.reinject (8.17.1.5/8.17.1.5) with ESMTP id 39R8Ig9V028975; Fri, 27 Oct 2023 08:19:00 GMT Received: from t460-2.nl.oracle.com (dhcp-10-175-63-126.vpn.oracle.com [10.175.63.126]) by phxpaimrmta03.imrmtpd1.prodappphxaev1.oraclevcn.com (PPS) with ESMTP id 3tywqjeb1g-7; Fri, 27 Oct 2023 08:19:00 +0000 From: Vegard Nossum To: linux-doc@vger.kernel.org, Jonathan Corbet , Mauro Carvalho Chehab Cc: Jani Nikula , linux-kernel@vger.kernel.org, Vegard Nossum , Richard Cochran , SeongJae Park , Hans de Goede , Armin Wolf , Iwona Winiarska , =?UTF-8?q?Ricardo=20Ca=C3=B1uelo?= , Tomas Winkler , linux-media@vger.kernel.org, Yanteng Si , Alex Shi , Wu XiangCheng Subject: [PATCH RFC 06/11] docs: driver-api: properly format ToC headings Date: Fri, 27 Oct 2023 10:18:25 +0200 Message-Id: <20231027081830.195056-7-vegard.nossum@oracle.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231027081830.195056-1-vegard.nossum@oracle.com> References: <20231027081830.195056-1-vegard.nossum@oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.272,Aquarius:18.0.987,Hydra:6.0.619,FMLib:17.11.176.26 definitions=2023-10-27_06,2023-10-26_01,2023-05-22_02 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 phishscore=0 mlxlogscore=999 mlxscore=0 spamscore=0 suspectscore=0 adultscore=0 bulkscore=0 malwarescore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2310240000 definitions=main-2310270071 X-Proofpoint-GUID: wz7HOd5et-SDzZciojXibt6vUTGSeytM X-Proofpoint-ORIG-GUID: wz7HOd5et-SDzZciojXibt6vUTGSeytM Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org "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 Cc: Richard Cochran Cc: SeongJae Park Cc: Hans de Goede Cc: Armin Wolf Cc: Iwona Winiarska Cc: "Ricardo Ca=C3=B1uelo" Cc: Tomas Winkler Cc: linux-media@vger.kernel.org Cc: Yanteng Si Cc: Alex Shi Cc: Wu XiangCheng Signed-off-by: Vegard Nossum --- Documentation/driver-api/index.rst | 5 +---- Documentation/driver-api/media/index.rst | 7 +------ Documentation/driver-api/mei/index.rst | 7 +------ Documentation/driver-api/pci/index.rst | 5 +---- Documentation/translations/zh_CN/driver-api/gpio/index.rst | 3 +-- Documentation/translations/zh_CN/driver-api/index.rst | 5 +---- 6 files changed, 6 insertions(+), 26 deletions(-) diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/= index.rst index 1e16a40da3ba..4540f79a34a9 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -9,11 +9,8 @@ of device drivers. This document is an only somewhat orga= nized collection of some of those interfaces =E2=80=94 it will hopefully get better over ti= me! The available subsections can be seen below. =20 -.. class:: toc-title - - Table of contents - .. toctree:: + :caption: Table of contents :maxdepth: 2 =20 driver-model/index diff --git a/Documentation/driver-api/media/index.rst b/Documentation/drive= r-api/media/index.rst index 08e206567408..d5593182a3f9 100644 --- a/Documentation/driver-api/media/index.rst +++ b/Documentation/driver-api/media/index.rst @@ -20,13 +20,8 @@ Documentation/userspace-api/media/index.rst - for the userspace APIs used on media devices. =20 =20 -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 5 :numbered: =20 diff --git a/Documentation/driver-api/mei/index.rst b/Documentation/driver-= api/mei/index.rst index 3a22b522ee78..eae6f18f18cf 100644 --- a/Documentation/driver-api/mei/index.rst +++ b/Documentation/driver-api/mei/index.rst @@ -9,13 +9,8 @@ Intel(R) Management Engine Interface (Intel(R) MEI) **Copyright** |copy| 2019 Intel Corporation =20 =20 -.. only:: html - - .. class:: toc-title - - Table of Contents - .. toctree:: + :caption: Table of Contents :maxdepth: 3 =20 mei diff --git a/Documentation/driver-api/pci/index.rst b/Documentation/driver-= api/pci/index.rst index c6cf1fef61ce..a38e475cdbe3 100644 --- a/Documentation/driver-api/pci/index.rst +++ b/Documentation/driver-api/pci/index.rst @@ -4,11 +4,8 @@ The Linux PCI driver implementer's API guide =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -.. class:: toc-title - - Table of contents - .. toctree:: + :caption: Table of contents :maxdepth: 2 =20 pci diff --git a/Documentation/translations/zh_CN/driver-api/gpio/index.rst b/D= ocumentation/translations/zh_CN/driver-api/gpio/index.rst index 9ab64e94aced..9a6a14162a6c 100644 --- a/Documentation/translations/zh_CN/driver-api/gpio/index.rst +++ b/Documentation/translations/zh_CN/driver-api/gpio/index.rst @@ -14,9 +14,8 @@ =E9=80=9A=E7=94=A8=E5=9E=8B=E8=BE=93=E5=85=A5/=E8=BE=93=E5=87=BA=EF=BC=88G= PIO=EF=BC=89 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -=E7=9B=AE=E5=BD=95: - .. toctree:: + :caption: =E7=9B=AE=E5=BD=95 :maxdepth: 2 =20 legacy diff --git a/Documentation/translations/zh_CN/driver-api/index.rst b/Docume= ntation/translations/zh_CN/driver-api/index.rst index ba354e1f4e6d..92ff1b7fc3d3 100644 --- a/Documentation/translations/zh_CN/driver-api/index.rst +++ b/Documentation/translations/zh_CN/driver-api/index.rst @@ -17,11 +17,8 @@ Linux=E9=A9=B1=E5=8A=A8=E5=AE=9E=E7=8E=B0=E8=80=85=E7=9A= =84API=E6=8C=87=E5=8D=97 =E5=86=85=E6=A0=B8=E6=8F=90=E4=BE=9B=E4=BA=86=E5=90=84=E7=A7=8D=E5=90=84= =E6=A0=B7=E7=9A=84=E6=8E=A5=E5=8F=A3=E6=9D=A5=E6=94=AF=E6=8C=81=E8=AE=BE=E5= =A4=87=E9=A9=B1=E5=8A=A8=E7=9A=84=E5=BC=80=E5=8F=91=E3=80=82=E8=BF=99=E4=BB= =BD=E6=96=87=E6=A1=A3=E5=8F=AA=E6=98=AF=E5=AF=B9=E5=85=B6=E4=B8=AD=E4=B8=80= =E4=BA=9B=E6=8E=A5=E5=8F=A3=E8=BF=9B=E8=A1=8C=E4=BA=86 =E4=B8=80=E5=AE=9A=E7=A8=8B=E5=BA=A6=E7=9A=84=E6=95=B4=E7=90=86=E2=80=94= =E2=80=94=E5=B8=8C=E6=9C=9B=E9=9A=8F=E7=9D=80=E6=97=B6=E9=97=B4=E7=9A=84=E6= =8E=A8=E7=A7=BB=EF=BC=8C=E5=AE=83=E8=83=BD=E5=8F=98=E5=BE=97=E6=9B=B4=E5=A5= =BD=EF=BC=81=E5=8F=AF=E7=94=A8=E7=9A=84=E5=B0=8F=E8=8A=82=E5=8F=AF=E4=BB=A5= =E5=9C=A8=E4=B8=8B=E9=9D=A2=E7=9C=8B=E5=88=B0=E3=80=82 =20 -.. class:: toc-title - - =E7=9B=AE=E5=BD=95=E5=88=97=E8=A1=A8=EF=BC=9A - .. toctree:: + :caption: =E7=9B=AE=E5=BD=95=E5=88=97=E8=A1=A8 :maxdepth: 2 =20 gpio/index --=20 2.34.1