[{"id":30870,"web_url":"https://patchwork.libcamera.org/comment/30870/","msgid":"<20240820132242.GB7478@pendragon.ideasonboard.com>","date":"2024-08-20T13:22:42","subject":"Re: [PATCH v4 8/9] Documentation: Add internal-api-html placeholder","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Dan,\n\nThank you for the patch.\n\nOn Tue, Aug 20, 2024 at 02:07:39PM +0100, Daniel Scally wrote:\n> Mimicing the existing api-html placeholder, add a placeholder for the\n\ns/Mimicing/Mimicking/\n\n> internal version of the Doxygen generated API documentation so that\n> the website can generate hyperlinks to it properly.\n> \n> Signed-off-by: Daniel Scally \n> ---\n> Changes since v3:\n> \n> \t- New patch\n> \n> Documentation/documentation-contents.rst | 1 +\n> Documentation/internal-api-html/index.rst | 8 ++++++++\n> Documentation/introduction.rst | 1 +\n> 3 files changed, 10 insertions(+)\n> create mode 100644 Documentation/internal-api-html/index.rst\n> \n> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n> index c14389bc..912b13f3 100644\n> --- a/Documentation/documentation-contents.rst\n> +++ b/Documentation/documentation-contents.rst\n> @@ -3,6 +3,7 @@\n> .. container:: documentation-nav\n> \n> * :doc:`/api-html/index`\n> + * :doc:`/internal-api-html/index`\n> * :doc:`/camera-sensor-model`\n> * :doc:`/code-of-conduct`\n> * :doc:`/coding-style`\n> diff --git a/Documentation/internal-api-html/index.rst b/Documentation/internal-api-html/index.rst\n> new file mode 100644\n> index 00000000..0044a2d1\n> --- /dev/null\n> +++ b/Documentation/internal-api-html/index.rst\n> @@ -0,0 +1,8 @@\n> +.. SPDX-License-Identifier: CC-BY-SA-4.0\n> +\n> +.. _internal-api:\n> +\n> +Internal API\n\nWhat if you named this \"Internal API Reference\" (and renamed \"API\" to\n\"API Reference\" in the corresponding file, would that allow removing the\nmanual labels from Documentation/documentation-contents.rst in patch\n9/9 ?\n\nReviewed-by: Laurent Pinchart \n\n> +============\n> +\n> +:: Placeholder for Doxygen documentation\n> diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst\n> index 8f96c65f..5c64d08c 100644\n> --- a/Documentation/introduction.rst\n> +++ b/Documentation/introduction.rst\n> @@ -13,6 +13,7 @@ Documentation\n> :hidden:\n> \n> API \n> + Internal API \n> \n> What is libcamera?\n> ==================","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3E0EFC323E\n\tfor ;\n\tTue, 20 Aug 2024 13:22:48 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 66BD9633CE;\n\tTue, 20 Aug 2024 15:22:47 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 5C7CC633B2\n\tfor ;\n\tTue, 20 Aug 2024 15:22:45 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id EF1394CC;\n\tTue, 20 Aug 2024 15:21:42 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"UTiL833n\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724160103;\n\tbh=RDaaRHaPR4VZyu0izbPEWI0suNr+vxs8UVRImpDSCCU=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=UTiL833n+boINbBYe9dGDV7uKb9VMKUneAFBb2xxfziRhq5J1Hnc12M7U9k4FPe3D\n\tztPSvMSXmL+HrmJNfc4gWnYMStwgy5WFlxegrveHEDw/y9u/MbGPom6fxzSbO5NaR5\n\tUBGw2/xWbqnCTugNR1dhx6gSPmP5BS2ipIYMbYYQ=","Date":"Tue, 20 Aug 2024 16:22:42 +0300","From":"Laurent Pinchart ","To":"Daniel Scally ","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH v4 8/9] Documentation: Add internal-api-html placeholder","Message-ID":"<20240820132242.GB7478@pendragon.ideasonboard.com>","References":"<20240820130740.568243-1-dan.scally@ideasonboard.com>\n\t<20240820130740.568243-9-dan.scally@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20240820130740.568243-9-dan.scally@ideasonboard.com>","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]