From mboxrd@z Thu Jan 1 00:00:00 1970 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 686AEC25B47 for ; Fri, 27 Oct 2023 08:32:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1345404AbjJ0Ic3 (ORCPT ); Fri, 27 Oct 2023 04:32:29 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44938 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230101AbjJ0Ic1 (ORCPT ); Fri, 27 Oct 2023 04:32:27 -0400 Received: from mgamail.intel.com (mgamail.intel.com [192.55.52.136]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 15EFBFA; Fri, 27 Oct 2023 01:32:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1698395544; x=1729931544; h=from:to:cc:subject:in-reply-to:references:date: message-id:mime-version; bh=j5JdL0JhDPE1qf2jcF+jt7NERWD/QscJA3GN/POMpvg=; b=Snl03ME5osuqFkjpdpAa0qOpwFfA4zpHv8RnIDYwpV+oZnsYmug29vDl Loc0/QxJ9P7T/nAc+jkVYmVXmWu6WajAAOncMHLDlRmGnJM86htZFX5Mc 41HiXfzWv3wYzQjYFyJFlWarhpOV1EexBgdy4KH3z2Xwy1Y2PimvZN+6c hbGQgYarxkkeqC1YY8AhSNHc23oh+zxeSmKyeRYdybvQrDaGBy2Vs5e1V AQgZaTdDpUcifVkrnUT6FzLssoj8YxCoTiUHW5Ry52tNxPWoSupsgSupw Zm4094omwwgCTBgrRiJXiBhUqQEwoqiZDsfsrXCDI13Ww+Kv5y1jTNUtD w==; X-IronPort-AV: E=McAfee;i="6600,9927,10875"; a="367078434" X-IronPort-AV: E=Sophos;i="6.03,255,1694761200"; d="scan'208";a="367078434" Received: from orviesa002.jf.intel.com ([10.64.159.142]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2023 01:32:23 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.03,255,1694761200"; d="scan'208";a="738231" Received: from jhajducz-mobl.ger.corp.intel.com (HELO localhost) ([10.252.34.19]) by orviesa002-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 27 Oct 2023 01:31:41 -0700 From: Jani Nikula To: Vegard Nossum , linux-doc@vger.kernel.org, Jonathan Corbet , Mauro Carvalho Chehab Cc: linux-kernel@vger.kernel.org, Vegard Nossum , Alex Shi , Armin Wolf , Dmitry Torokhov , Fangrui Song , Federico Vaga , gaochao , Greg Kroah-Hartman , Hans de Goede , Hu Haowen , Iwona Winiarska , Julien Panis , Ricardo =?utf-8?Q?Ca=C3=B1uelo?= , Richard Cochran , Rui Li , SeongJae Park , Stephan Mueller , Tomas Winkler , Wan Jiabing , Wu XiangCheng , Yanteng Si Subject: Re: [PATCH RFC 00/11] use toctree :caption: for ToC headings In-Reply-To: <20231027081830.195056-1-vegard.nossum@oracle.com> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <20231027081830.195056-1-vegard.nossum@oracle.com> Date: Fri, 27 Oct 2023 11:32:12 +0300 Message-ID: <874jic79f7.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, 27 Oct 2023, Vegard Nossum wrote: > 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. Patch 1 is a matter of taste, I guess. I'll leave it to Jon. Everything else LGTM. For the benefit of others, the toctree directive gained the "caption" option in Sphinx 1.3 [1]. BR, Jani. [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html > > > 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(-) -- Jani Nikula, Intel