Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:4 as permitted sender) client-ip=2620:137:e000::3:4;
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>,
        Alex Shi <alexs@kernel.org>, Armin Wolf <W_Armin@gmx.de>,
        Dmitry Torokhov <dmitry.torokhov@gmail.com>,
        Fangrui Song <maskray@google.com>,
        Federico Vaga <federico.vaga@vaga.pv.it>,
        gaochao <gaochao49@huawei.com>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Hans de Goede <hdegoede@redhat.com>,
        Hu Haowen <src.res.211@gmail.com>,
        Iwona Winiarska <iwona.winiarska@intel.com>,
        Julien Panis <jpanis@baylibre.com>,
        =?UTF-8?q?Ricardo=20Ca=C3=B1uelo?= <ricardo.canuelo@collabora.com>,
        Richard Cochran <richardcochran@gmail.com>,
        Rui Li <me@lirui.org>, SeongJae Park <sj@kernel.org>,
        Stephan Mueller <smueller@chronox.de>,
        Tomas Winkler <tomas.winkler@intel.com>,
        Wan Jiabing <wanjiabing@vivo.com>,
        Wu XiangCheng <bobwxc@email.cn>,
        Yanteng Si <siyanteng@loongson.cn>
Subject: [PATCH RFC 00/11] use toctree :caption: for ToC headings
Date:   Fri, 27 Oct 2023 10:18:19 +0200
Message-Id: <20231027081830.195056-1-vegard.nossum@oracle.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Precedence: bulk

Hi,

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.

There are some dependencies here: the first patch is necessary for the
headings in following patches to be styled correctly with the alabaster
theme (rtd_sphinx already has it), and the last patch depends on most
of the previous patches to not use the old .toc-title class anymore.

Assuming people agree with the general direction, I thought maybe the
easiest thing would be to collect maintainer acks in this round and
then for me to resubmit everything to the documentation tree/maintainer
in one go.


Vegard

---

Vegard Nossum (11):
  docs: style toctree captions as headings
  doc: userspace-api: properly format ToC headings
  media: admin-guide: properly format ToC heading
  crypto: doc: properly format ToC headings
  Documentation: dev-tools: properly format ToC headingss
  docs: driver-api: properly format ToC headings
  input: docs: properly format ToC headings
  doc: misc-device: properly format ToC heading
  media: doc: properly format ToC headings
  docs: use toctree :caption: and move introduction
  docs: remove .toc-title class

 Documentation/admin-guide/media/index.rst     | 10 +---------
 Documentation/crypto/api.rst                  |  5 +----
 Documentation/crypto/index.rst                |  5 +----
 Documentation/dev-tools/index.rst             |  5 +----
 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/input/input_kapi.rst            |  5 +----
 Documentation/input/input_uapi.rst            |  5 +----
 Documentation/input/joydev/index.rst          |  5 +----
 Documentation/misc-devices/index.rst          |  5 +----
 Documentation/process/development-process.rst | 19 +++++++++----------
 Documentation/sphinx-static/custom.css        |  3 +++
 .../sphinx-static/theme_overrides.css         |  5 -----
 .../it_IT/process/development-process.rst     | 19 +++++++++----------
 .../translations/zh_CN/dev-tools/index.rst    |  5 +----
 .../zh_CN/driver-api/gpio/index.rst           |  3 +--
 .../translations/zh_CN/driver-api/index.rst   |  5 +----
 .../zh_CN/process/development-process.rst     |  5 ++---
 .../zh_CN/userspace-api/index.rst             |  5 +----
 .../zh_TW/process/development-process.rst     |  5 ++---
 Documentation/userspace-api/index.rst         |  5 +----
 .../userspace-api/media/cec/cec-api.rst       |  7 +------
 .../userspace-api/media/drivers/index.rst     |  7 +------
 .../userspace-api/media/dvb/dvbapi.rst        |  7 +------
 Documentation/userspace-api/media/index.rst   |  7 +------
 .../media/mediactl/media-controller.rst       |  7 +------
 .../media/rc/remote_controllers.rst           |  7 +------
 .../userspace-api/media/v4l/v4l2.rst          |  7 +------
 30 files changed, 49 insertions(+), 148 deletions(-)

-- 
2.34.1