From patchwork Thu Aug 22 08:16:06 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20987 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 7226EBDE17 for ; Thu, 22 Aug 2024 08:16:30 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id B9D68633D6; Thu, 22 Aug 2024 10:16:25 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="kFtmPmCH"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C8D38633CB for ; Thu, 22 Aug 2024 10:16:22 +0200 (CEST) Received: from mail.ideasonboard.com (cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 6B0668A9; Thu, 22 Aug 2024 10:15:19 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724314519; bh=/IUUC2kMYj4SMMJPkngnNMwx3DeKkbLMvDeN4QoAET4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=kFtmPmCHL8TG683s1nN0y6IxI1sTUn7+5YPAkxLhTjhKqf9GKLZPaj2YN5YJ2IBwx f3gwG0h2EjxwuRLeY8LhQakFB0lTAC5M/peLrlf0fU8qdB2l50vZg/0AMlJ21QdToN Ef/HqcviCNkjPES+NT01HA9rNrDTwbAeU0HirO1s= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH 1/2] Documentation: Fix link to introduction on mainpage.dox Date: Thu, 22 Aug 2024 09:16:06 +0100 Message-Id: <20240822081607.911049-2-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240822081607.911049-1-dan.scally@ideasonboard.com> References: <20240822081607.911049-1-dan.scally@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" With the removal of guides/introduction.rst the link on the API reference landing page no longer works. Point it to the documents introduction page instead. Fixes: 860a3e30 ("Documentation: Rework docs.rst into introduction.rst") Signed-off-by: Daniel Scally Reviewed-by: Laurent Pinchart --- Documentation/mainpage.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index d5a57653..d04d932f 100644 --- a/Documentation/mainpage.dox +++ b/Documentation/mainpage.dox @@ -5,7 +5,7 @@ Welcome to the API reference for libcamera, a complex camera support library for Linux, Android and ChromeOS. These pages are automatically generated from the libcamera source code and describe the API in detail - if this is your first interaction with libcamera then you may find -it useful to visit the [developer's guide](../html/guides/introduction.html) in +it useful to visit the [documentation](../introduction.html) in the first instance, which can provide a more generic introduction to the library's concepts. From patchwork Thu Aug 22 08:16:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20988 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 16E50BDE17 for ; Thu, 22 Aug 2024 08:16:32 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 4CFE6633D1; Thu, 22 Aug 2024 10:16:28 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="bMoK+WxY"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 0FA90633CC for ; Thu, 22 Aug 2024 10:16:23 +0200 (CEST) Received: from mail.ideasonboard.com (cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id ADE278D0; Thu, 22 Aug 2024 10:15:19 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724314519; bh=LXN4rBgSEhQDHCaBp9SXiOiVl9cO8A0QxpoUcvg7lqI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=bMoK+WxYCtGVZYmFrBXBq9fw3Z587/SUFq6pZ7OqtzWF4axPsg3HVdv1cCD2bvqBM UJK7Oh1KwyHA6uSj5nPXjxzs8FCH2faZoVyCi+4ifV6O0h07yiff6IFBfOpxa4L5MR QKwNZbYUWOgxb7k7PMGHRlXTEY+yGYG1o/6LaKhQ= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH 2/2] Documentation: Fix links from API references to guides Date: Thu, 22 Aug 2024 09:16:07 +0100 Message-Id: <20240822081607.911049-3-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240822081607.911049-1-dan.scally@ideasonboard.com> References: <20240822081607.911049-1-dan.scally@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 links on the API reference mainpage to guides within the main libcamera documentation work built locally, but not through the website. As the website's more important make them work with the website paths as a temporary solution until a better one is devised. Fixes: e9388617 ("Documentation: Improve doxygen main page") Signed-off-by: Daniel Scally Reviewed-by: Laurent Pinchart --- Documentation/mainpage.dox | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index d04d932f..cbee9bab 100644 --- a/Documentation/mainpage.dox +++ b/Documentation/mainpage.dox @@ -12,8 +12,8 @@ library's concepts. \if internal As a follow-on to the developer's guide, to assist you in adding support for -your platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html) -and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful. +your platform the [pipeline handler writer's guide](../guides/pipeline-handler.html) +and the [ipa module writer's guide](../guides/ipa.html) should be helpful. The full libcamera API is documented here. If you wish to see only the public part of the API you can use [these pages](../api-html/index.html) instead. @@ -21,7 +21,7 @@ part of the API you can use [these pages](../api-html/index.html) instead. \else As a follow-on to the developer's guide, to assist you in using libcamera within -your project the [application developer's guide](../html/guides/application-developer.html) +your project the [application developer's guide](../guides/application-developer.html) gives an overview on how to achieve that. Only the public part of the libcamera API is documented here; if you are a