{"id":24336,"url":"https://patchwork.libcamera.org/api/patches/24336/?format=json","web_url":"https://patchwork.libcamera.org/patch/24336/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20250911230115.25335-8-laurent.pinchart@ideasonboard.com>","date":"2025-09-11T23:01:08","name":"[v2,07/10] Documentation: Include API docs in the sphinx documentation","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"596aaa1e46991b0e6d8d3743670f88f0be99c901","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/24336/mbox/","series":[{"id":5435,"url":"https://patchwork.libcamera.org/api/series/5435/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5435","date":"2025-09-11T23:01:01","name":"Documentation theming update","version":2,"mbox":"https://patchwork.libcamera.org/series/5435/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/24336/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/24336/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 1E133C324E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 11 Sep 2025 23:02:00 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 7A75D69386;\n\tFri, 12 Sep 2025 01:01:59 +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 AA36A6937D\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 12 Sep 2025 01:01:54 +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 UTF8SMTPSA id D13DB4579; \n\tFri, 12 Sep 2025 01:00:39 +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=\"R8/PC+44\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757631640;\n\tbh=TIwzx0fTJhFHyjo1d7irOFK0sIoWXLuWYK5eAH/Oklc=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=R8/PC+44CzftpQy3a6qyQd7swyp/ErL8qPyqtrwOA1GznNABI5pI45YMKF+90hOpP\n\tF0UW9mslQFb4nvSp/qFD8JfTpNBFK+2tU40+auuVdW73fwD8cUvEIsJXW5RJwaee6B\n\tjujkO3vluCcuHtwVSvaDOFbuIn937WZb7IeHuErg=","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"libcamera-devel@lists.libcamera.org","Cc":"Stefan Klug <stefan.klug@ideasonboard.com>","Subject":"[PATCH v2 07/10] Documentation: Include API docs in the sphinx\n\tdocumentation","Date":"Fri, 12 Sep 2025 02:01:08 +0300","Message-ID":"<20250911230115.25335-8-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.49.1","In-Reply-To":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>","References":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"From: Stefan Klug <stefan.klug@ideasonboard.com>\n\nThis commit prepares the move of all the libcamera documetation to a\nplace separate from the website. This makes it easier to handle website\nand docs separately.\n\nThe index is updated to mimic the structure currently available on the\nwebsite.\n\nSigned-off-by: Stefan Klug <stefan.klug@ideasonboard.com>\n---\nChanges since v1:\n\n- Split the build changes to a separate patch\n---\n Documentation/index.rst        | 45 ++++++++++++++++++++--------------\n Documentation/introduction.rst |  6 -----\n 2 files changed, 26 insertions(+), 25 deletions(-)","diff":"diff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 251112fbdf5f..d55b5ff21464 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -4,28 +4,35 @@\n \n .. toctree::\n    :maxdepth: 1\n-   :caption: Contents:\n+   :caption: For Users\n \n-   Home <self>\n-   Contribute <contributing>\n-   Getting Started <getting-started>\n-\n-   Application Writer's Guide <guides/application-developer>\n-   Camera Sensor Model <camera-sensor-model>\n-   Environment variables <environment_variables>\n+   Introduction <self>\n    Feature Requirements <feature_requirements>\n-   IPA Writer's guide <guides/ipa>\n-   Lens driver requirements <lens_driver_requirements>\n-   libcamera Architecture <libcamera_architecture>\n-   Pipeline Handler Writer's Guide <guides/pipeline-handler>\n+   Application Writer's Guide <guides/application-developer>\n    Python Bindings <python-bindings>\n-   Sensor driver requirements <sensor_driver_requirements>\n-   SoftwareISP Benchmarking <software-isp-benchmarking>\n-   Tracing guide <guides/tracing>\n-\n-   Design document: AE <design/ae>\n+   Environment variables <environment_variables>\n+   Public API <api-html/index>\n \n .. toctree::\n-   :hidden:\n+   :maxdepth: 1\n+   :caption: For Developers\n+\n+   Contribute <contributing>\n+   Getting Started <getting-started>\n+   Camera Sensor Model <camera-sensor-model>\n+   IPA Writer's guide <guides/ipa>\n+   libcamera Architecture <libcamera_architecture>\n+   Pipeline Handler Writer's Guide <guides/pipeline-handler>\n+   SoftwareISP Benchmarking <software-isp-benchmarking>\n+   Tracing guide <guides/tracing>\n+   Design document: AE <design/ae>\n+   Internal API <internal-api-html/index>\n+\n+.. toctree::\n+   :maxdepth: 1\n+   :caption: For System Integrators\n+\n+   Lens driver requirements <lens_driver_requirements>\n+   Sensor driver requirements <sensor_driver_requirements>\n+\n \n-   introduction\ndiff --git a/Documentation/introduction.rst b/Documentation/introduction.rst\nindex 82aa11a30f33..d76cebd05ee1 100644\n--- a/Documentation/introduction.rst\n+++ b/Documentation/introduction.rst\n@@ -6,12 +6,6 @@\n Introduction\n ************\n \n-.. toctree::\n-   :hidden:\n-\n-   API <api-html/index>\n-   Internal API <internal-api-html/index>\n-\n What is libcamera?\n ==================\n \n","prefixes":["v2","07/10"]}