From patchwork Wed Aug 21 00:40:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 20983 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id AAA38BDB13 for ; Wed, 21 Aug 2024 00:40:21 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 89761633CC; Wed, 21 Aug 2024 02:40:17 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="r0Y40vPg"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 86D0B633CB for ; Wed, 21 Aug 2024 02:40:11 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 276EA4CC for ; Wed, 21 Aug 2024 02:39:09 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724200749; bh=a/7OYuPFQW81ic7+lXcei9rZqimX0pGNvGuO59T/Jok=; h=From:To:Subject:Date:In-Reply-To:References:From; b=r0Y40vPgVgTekcSGCXKd+rkw1mc6VxZvc5KW1F/8MpLWiQuaXoloFnWpdRztJMg82 Ygp0AvdmViYSgcW+uDT+tfnuSLjxZQsYASEcdQD+FARsihXOTyeOIae2FycVlraE3i zueKr1IpjmGqtxPhUcDnc5syG9eaTn5D/gyZtu/g= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH 1/3] Documentation: Rename "API" section to "API Reference" Date: Wed, 21 Aug 2024 03:40:05 +0300 Message-ID: <20240821004007.28938-2-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240821004007.28938-1-laurent.pinchart@ideasonboard.com> References: <20240821004007.28938-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" "API" as a section name is as informative as it is long, that is to say, not very. Rename it to "API Reference" for improved clarity. Signed-off-by: Laurent Pinchart Reviewed-by: Daniel Scally --- Documentation/api-html/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst index 9e630fc0e6b4..2f09833d1dc1 100644 --- a/Documentation/api-html/index.rst +++ b/Documentation/api-html/index.rst @@ -2,7 +2,7 @@ .. _api: -API -=== +API Reference +============= :: Placeholder for Doxygen documentation From patchwork Wed Aug 21 00:40:06 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 20982 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 0E5C9BDB13 for ; Wed, 21 Aug 2024 00:40:17 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id E4340633D3; Wed, 21 Aug 2024 02:40:15 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="Y06/+0iZ"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 37FC3633CC for ; Wed, 21 Aug 2024 02:40:13 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id BEC374CC for ; Wed, 21 Aug 2024 02:39:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724200751; bh=LbWAJHCDqQQdTAMYp3eo5KKol+mEb5I8gJPgm4VXWfI=; h=From:To:Subject:Date:In-Reply-To:References:From; b=Y06/+0iZla7wnoeMp5xktVIHB4iY8IE0T5mzH4LCUlZEudblX1bXcOJHar+H+F+ar FkHx78aA4xvNVLCGdmQfxaQfLyYi2dU6V7xJ6osnOVpl5hzbNOeHOB+GoVm3mrx/q7 M+T5/KaznqY9KWhvZ6ikt0Qvo1QgUtp8hQb1X0yM= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH 2/3] Documentation: Drop local table of contents from introduction Date: Wed, 21 Aug 2024 03:40:06 +0300 Message-ID: <20240821004007.28938-3-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240821004007.28938-1-laurent.pinchart@ideasonboard.com> References: <20240821004007.28938-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The local table of contents from the introduction page doesn't provide much navigation value as the page is short. It also stands out, as no other page has a local table of contents. Drop it, we will reintroduce local tables of contents more globally if needed later. Signed-off-by: Laurent Pinchart Reviewed-by: Daniel Scally --- Documentation/introduction.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst index 5c64d08c8a26..8c3d0f031233 100644 --- a/Documentation/introduction.rst +++ b/Documentation/introduction.rst @@ -1,8 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. contents:: - :local: - .. include:: documentation-contents.rst ************* From patchwork Wed Aug 21 00:40:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 20985 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 6D2EABDB13 for ; Wed, 21 Aug 2024 00:40:25 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 32B8D633D8; Wed, 21 Aug 2024 02:40:22 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="tfVITvj+"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 936526190A for ; Wed, 21 Aug 2024 02:40:14 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 354B24CC for ; Wed, 21 Aug 2024 02:39:12 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724200752; bh=1nsDen25R6OaB5Wg2QLYAh01WLjhwrad8qhKRsr/iSQ=; h=From:To:Subject:Date:In-Reply-To:References:From; b=tfVITvj+w6xLrUSJVZzPIrrz9UzV0KHaVDwric9zdWj+jCIxtypd0U9I5RvE9nqU6 eoZHrgAQWcZEjWk3ONC4YtLVByCPgsZzdjVtPiAViYfZjRlO+OasOpyhkGl6m44U8J Ca44S7jkG0xjMgeT43fiyanba9/Nh+W0uA1MeCJ0= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH 3/3] Documentation: Rename "Documentation" section to "Introduction" Date: Wed, 21 Aug 2024 03:40:07 +0300 Message-ID: <20240821004007.28938-4-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.44.2 In-Reply-To: <20240821004007.28938-1-laurent.pinchart@ideasonboard.com> References: <20240821004007.28938-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The introduction.rst file contains the introduction to the libcamera documentation. Rename the section from "Documentation" to "Introduction". Signed-off-by: Laurent Pinchart Reviewed-by: Daniel Scally --- Documentation/introduction.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst index 8c3d0f031233..82aa11a30f33 100644 --- a/Documentation/introduction.rst +++ b/Documentation/introduction.rst @@ -2,9 +2,9 @@ .. include:: documentation-contents.rst -************* -Documentation -************* +************ +Introduction +************ .. toctree:: :hidden: