Merge branch 'vegard' into docs-mw

Vegard Nossum writes:

  This patch series replaces some instances of 'class:: toc-title' with
  toctree's :caption: attribute, see the last patch in the series for some
  more rationale/explanation.
This commit is contained in:
Jonathan Corbet 2023-11-17 13:07:51 -07:00
commit d591aefc66
30 changed files with 49 additions and 147 deletions

View File

@ -20,16 +20,8 @@ Documentation/driver-api/media/index.rst
- for driver development information and Kernel APIs used by - for driver development information and Kernel APIs used by
media devices; media devices;
The media subsystem
===================
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 2 :maxdepth: 2
:numbered: :numbered:

View File

@ -1,11 +1,8 @@
Programming Interface Programming Interface
===================== =====================
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
api-skcipher api-skcipher

View File

@ -9,11 +9,8 @@ This documentation outlines the Linux kernel crypto API with its
concepts, details about developing cipher implementations, employment of the API concepts, details about developing cipher implementations, employment of the API
for cryptographic use cases, as well as programming examples. for cryptographic use cases, as well as programming examples.
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
intro intro

View File

@ -10,11 +10,8 @@ whole; patches welcome!
A brief overview of testing-specific tools can be found in A brief overview of testing-specific tools can be found in
Documentation/dev-tools/testing-overview.rst Documentation/dev-tools/testing-overview.rst
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
testing-overview testing-overview

View File

@ -9,11 +9,8 @@ of device drivers. This document is an only somewhat organized collection
of some of those interfaces — it will hopefully get better over time! The of some of those interfaces — it will hopefully get better over time! The
available subsections can be seen below. available subsections can be seen below.
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
driver-model/index driver-model/index

View File

@ -20,13 +20,8 @@ Documentation/userspace-api/media/index.rst
- for the userspace APIs used on media devices. - for the userspace APIs used on media devices.
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:

View File

@ -9,13 +9,8 @@ Intel(R) Management Engine Interface (Intel(R) MEI)
**Copyright** |copy| 2019 Intel Corporation **Copyright** |copy| 2019 Intel Corporation
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 3 :maxdepth: 3
mei mei

View File

@ -4,11 +4,8 @@
The Linux PCI driver implementer's API guide The Linux PCI driver implementer's API guide
============================================ ============================================
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
pci pci

View File

@ -4,11 +4,8 @@
Linux Input Subsystem kernel API Linux Input Subsystem kernel API
################################ ################################
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 2 :maxdepth: 2
:numbered: :numbered:

View File

@ -4,11 +4,8 @@
Linux Input Subsystem userspace API Linux Input Subsystem userspace API
################################### ###################################
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 2 :maxdepth: 2
:numbered: :numbered:

View File

@ -6,11 +6,8 @@ Linux Joystick support
:Copyright: |copy| 1996-2000 Vojtech Pavlik <vojtech@ucw.cz> - Sponsored by SuSE :Copyright: |copy| 1996-2000 Vojtech Pavlik <vojtech@ucw.cz> - Sponsored by SuSE
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 3 :maxdepth: 3
joystick joystick

View File

@ -7,11 +7,8 @@ Assorted Miscellaneous Devices Documentation
This documentation contains information for assorted devices that do not This documentation contains information for assorted devices that do not
fit into other categories. fit into other categories.
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
ad525x_dpot ad525x_dpot

View File

@ -3,9 +3,17 @@
A guide to the Kernel Development Process A guide to the Kernel Development Process
========================================= =========================================
Contents: The purpose of this document is to help developers (and their managers)
work with the development community with a minimum of frustration. It is
an attempt to document how this community works in a way which is
accessible to those who are not intimately familiar with Linux kernel
development (or, indeed, free software development in general). While
there is some technical material here, this is very much a process-oriented
discussion which does not require a deep knowledge of kernel programming to
understand.
.. toctree:: .. toctree::
:caption: Contents
:numbered: :numbered:
:maxdepth: 2 :maxdepth: 2
@ -17,12 +25,3 @@ Contents:
6.Followthrough 6.Followthrough
7.AdvancedTopics 7.AdvancedTopics
8.Conclusion 8.Conclusion
The purpose of this document is to help developers (and their managers)
work with the development community with a minimum of frustration. It is
an attempt to document how this community works in a way which is
accessible to those who are not intimately familiar with Linux kernel
development (or, indeed, free software development in general). While
there is some technical material here, this is very much a process-oriented
discussion which does not require a deep knowledge of kernel programming to
understand.

View File

@ -8,6 +8,9 @@ div.body h1 { font-size: 180%; }
div.body h2 { font-size: 150%; } div.body h2 { font-size: 150%; }
div.body h3 { font-size: 130%; } div.body h3 { font-size: 130%; }
/* toctree captions are styled like h2 */
div.toctree-wrapper p.caption[role=heading] { font-size: 150%; }
/* Tighten up the layout slightly */ /* Tighten up the layout slightly */
div.body { padding: 0 15px 0 10px; } div.body { padding: 0 15px 0 10px; }
div.sphinxsidebarwrapper { padding: 1em 0.4em; } div.sphinxsidebarwrapper { padding: 1em 0.4em; }

View File

@ -81,11 +81,6 @@ div[class^="highlight"] pre {
* - hide the permalink symbol as long as link is not hovered * - hide the permalink symbol as long as link is not hovered
*/ */
.toc-title {
font-size: 150%;
font-weight: bold;
}
caption, .wy-table caption, .rst-content table.field-list caption { caption, .wy-table caption, .rst-content table.field-list caption {
font-size: 100%; font-size: 100%;
} }

View File

@ -8,9 +8,17 @@
Una guida al processo di sviluppo del Kernel Una guida al processo di sviluppo del Kernel
============================================ ============================================
Contenuti: Lo scopo di questo documento è quello di aiutare gli sviluppatori (ed i loro
supervisori) a lavorare con la communità di sviluppo con il minimo sforzo. È
un tentativo di documentare il funzionamento di questa communità in modo che
sia accessibile anche a coloro che non hanno famigliarità con lo sviluppo del
Kernel Linux (o, anzi, con lo sviluppo di software libero in generale). Benchè
qui sia presente del materiale tecnico, questa è una discussione rivolta in
particolare al procedimento, e quindi per essere compreso non richiede una
conoscenza approfondità sullo sviluppo del kernel.
.. toctree:: .. toctree::
:caption: Contenuti
:numbered: :numbered:
:maxdepth: 2 :maxdepth: 2
@ -22,12 +30,3 @@ Contenuti:
6.Followthrough 6.Followthrough
7.AdvancedTopics 7.AdvancedTopics
8.Conclusion 8.Conclusion
Lo scopo di questo documento è quello di aiutare gli sviluppatori (ed i loro
supervisori) a lavorare con la communità di sviluppo con il minimo sforzo. È
un tentativo di documentare il funzionamento di questa communità in modo che
sia accessibile anche a coloro che non hanno famigliarità con lo sviluppo del
Kernel Linux (o, anzi, con lo sviluppo di software libero in generale). Benchè
qui sia presente del materiale tecnico, questa è una discussione rivolta in
particolare al procedimento, e quindi per essere compreso non richiede una
conoscenza approfondità sullo sviluppo del kernel.

View File

@ -14,11 +14,8 @@
有关测试专用工具的简要概述,参见 有关测试专用工具的简要概述,参见
Documentation/translations/zh_CN/dev-tools/testing-overview.rst Documentation/translations/zh_CN/dev-tools/testing-overview.rst
.. class:: toc-title
目录
.. toctree:: .. toctree::
:caption: 目录
:maxdepth: 2 :maxdepth: 2
testing-overview testing-overview

View File

@ -14,9 +14,8 @@
通用型输入/输出GPIO 通用型输入/输出GPIO
======================= =======================
目录:
.. toctree:: .. toctree::
:caption: 目录
:maxdepth: 2 :maxdepth: 2
legacy legacy

View File

@ -17,11 +17,8 @@ Linux驱动实现者的API指南
内核提供了各种各样的接口来支持设备驱动的开发。这份文档只是对其中一些接口进行了 内核提供了各种各样的接口来支持设备驱动的开发。这份文档只是对其中一些接口进行了
一定程度的整理——希望随着时间的推移,它能变得更好!可用的小节可以在下面看到。 一定程度的整理——希望随着时间的推移,它能变得更好!可用的小节可以在下面看到。
.. class:: toc-title
目录列表:
.. toctree:: .. toctree::
:caption: 目录列表
:maxdepth: 2 :maxdepth: 2
gpio/index gpio/index

View File

@ -8,9 +8,10 @@
内核开发过程指南 内核开发过程指南
================ ================
内容: 本文档的目的是帮助开发人员及其经理以最小的挫折感与开发社区合作。它试图记录这个社区如何以一种不熟悉Linux内核开发或者实际上是自由软件开发的人可以访问的方式工作。虽然这里有一些技术资料但这是一个面向过程的讨论不需要深入了解内核编程就可以理解。
.. toctree:: .. toctree::
:caption: 内容
:numbered: :numbered:
:maxdepth: 2 :maxdepth: 2
@ -22,5 +23,3 @@
6.Followthrough 6.Followthrough
7.AdvancedTopics 7.AdvancedTopics
8.Conclusion 8.Conclusion
本文档的目的是帮助开发人员及其经理以最小的挫折感与开发社区合作。它试图记录这个社区如何以一种不熟悉Linux内核开发或者实际上是自由软件开发的人可以访问的方式工作。虽然这里有一些技术资料但这是一个面向过程的讨论不需要深入了解内核编程就可以理解。

View File

@ -17,11 +17,8 @@ Linux 内核用户空间API指南
在代码树中仍然可以找到有关用户空间的部分信息。这个手册意在成为这些信息 在代码树中仍然可以找到有关用户空间的部分信息。这个手册意在成为这些信息
聚集的地方。 聚集的地方。
.. class:: toc-title
目录
.. toctree:: .. toctree::
:caption: 目录
:maxdepth: 2 :maxdepth: 2
no_new_privs no_new_privs

View File

@ -11,9 +11,10 @@
內核開發過程指南 內核開發過程指南
================ ================
內容: 本文檔的目的是幫助開發人員及其經理以最小的挫折感與開發社區合作。它試圖記錄這個社區如何以一種不熟悉Linux內核開發或者實際上是自由軟體開發的人可以訪問的方式工作。雖然這裡有一些技術資料但這是一個面向過程的討論不需要深入了解內核編程就可以理解。
.. toctree:: .. toctree::
:caption: 內容
:numbered: :numbered:
:maxdepth: 2 :maxdepth: 2
@ -27,4 +28,3 @@
8.Conclusion 8.Conclusion
本文檔的目的是幫助開發人員及其經理以最小的挫折感與開發社區合作。它試圖記錄這個社區如何以一種不熟悉Linux內核開發或者實際上是自由軟件開發的人可以訪問的方式工作。雖然這裏有一些技術資料但這是一個面向過程的討論不需要深入瞭解內核編程就可以理解。 本文檔的目的是幫助開發人員及其經理以最小的挫折感與開發社區合作。它試圖記錄這個社區如何以一種不熟悉Linux內核開發或者實際上是自由軟件開發的人可以訪問的方式工作。雖然這裏有一些技術資料但這是一個面向過程的討論不需要深入瞭解內核編程就可以理解。

View File

@ -9,11 +9,8 @@ While much of the kernel's user-space API is documented elsewhere
also be found in the kernel tree itself. This manual is intended to be the also be found in the kernel tree itself. This manual is intended to be the
place where this information is gathered. place where this information is gathered.
.. class:: toc-title
Table of contents
.. toctree:: .. toctree::
:caption: Table of contents
:maxdepth: 2 :maxdepth: 2
no_new_privs no_new_privs

View File

@ -10,13 +10,8 @@ Part V - Consumer Electronics Control API
This part describes the CEC: Consumer Electronics Control This part describes the CEC: Consumer Electronics Control
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:

View File

@ -21,13 +21,8 @@ more details.
For more details see the file COPYING in the source distribution of Linux. For more details see the file COPYING in the source distribution of Linux.
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:

View File

@ -27,13 +27,8 @@ Part II - Digital TV API
**Version 5.10** **Version 5.10**
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:

View File

@ -21,13 +21,8 @@ Documentation/driver-api/media/index.rst
media devices; media devices;
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 1 :maxdepth: 1
intro intro

View File

@ -7,13 +7,8 @@
Part IV - Media Controller API Part IV - Media Controller API
############################## ##############################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:

View File

@ -7,13 +7,8 @@
Part III - Remote Controller API Part III - Remote Controller API
################################ ################################
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:

View File

@ -11,13 +11,8 @@ This part describes the Video for Linux API version 2 (V4L2 API) specification.
**Revision 4.5** **Revision 4.5**
.. only:: html
.. class:: toc-title
Table of Contents
.. toctree:: .. toctree::
:caption: Table of Contents
:numbered: :numbered:
:maxdepth: 5 :maxdepth: 5