Patch Detail
Show a patch.
GET /api/patches/24384/?format=api
{ "id": 24384, "url": "https://patchwork.libcamera.org/api/patches/24384/?format=api", "web_url": "https://patchwork.libcamera.org/patch/24384/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20250917201742.16406-7-laurent.pinchart@ideasonboard.com>", "date": "2025-09-17T20:17:37", "name": "[v3,06/10] Documentation: Reorganize toctree", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "596aaa1e46991b0e6d8d3743670f88f0be99c901", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/24384/mbox/", "series": [ { "id": 5448, "url": "https://patchwork.libcamera.org/api/series/5448/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=5448", "date": "2025-09-17T20:17:31", "name": "Documentation theming update", "version": 3, "mbox": "https://patchwork.libcamera.org/series/5448/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/24384/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/24384/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 6FE7FC328C\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 17 Sep 2025 20:18:31 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 088F969385;\n\tWed, 17 Sep 2025 22:18:31 +0200 (CEST)", "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id DC0CF6937B\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 17 Sep 2025 22:18:21 +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 B6248164C; \n\tWed, 17 Sep 2025 22:17:02 +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=\"rz/7CZqG\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1758140222;\n\tbh=Z5HdlBmEqK1abtJPIYUqwr24PZO2TM9peYPnTQwbkRY=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=rz/7CZqGfwpn1BCvXWTj+TDhnKh1BHMIfElv+hMQ1j0YAiyx7vheMsdNKEaLGD87j\n\tBsqVfUV0SYizBYv/9+AFni1J7cP4dwlufv6FpflQskYs2/6qJ4o8E7W5M4cYAzIUSR\n\tN+ZwcEAetXmUcVN9+S6RHv+ccpKNGzh8w4eqdKm4=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Stefan Klug <stefan.klug@ideasonboard.com>", "Subject": "[PATCH v3 06/10] Documentation: Reorganize toctree", "Date": "Wed, 17 Sep 2025 23:17:37 +0300", "Message-ID": "<20250917201742.16406-7-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.49.1", "In-Reply-To": "<20250917201742.16406-1-laurent.pinchart@ideasonboard.com>", "References": "<20250917201742.16406-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\nThe libcamera Sphinx documentation contains three toctrees: a main\ntoctree that contains all documentation pages in a flat hierarchy, and\ntwo hidden toctrees that point to the introduction and API pages. This\narchitecture is mostly meant to support publishing the documentation on\nthe libcamera.org website. The process recreates a hybrid documentation\ntree mixing content specific to the website and content extracted from\nlibcamera. The hidden toctrees are used to prevent Sphinx from warning\nabout unreferenced pages when the documentation is built as part of\nlibcamera.\n\nThis set of hacks work, but produce unorganized documentation in the\nbuild directory, as well as when installed to the system. Furthermore,\nthey make it difficult to host multiple versions of the libcamera\ndocumentation on the website, which we will eventually want to do as the\nAPI stabilizes. It would be generally better to host on libcamera.org\nthe documentation built as part of libcamera with the same structure of\ndocuments.\n\nTo prepare for that change, reorganize the toctrees in libcamera with\nthree visible trees: a toctree for users, a toctree for developers, and\na toctree for integrators. Include the public and internal API pages\nin the first two trees respectively. This mimics the structure of the\ndocumentation as currently organized on the website. The resulting\ndocumentation becomes easier to navigate in the build and installation\ndirectories.\n\nSigned-off-by: Stefan Klug <stefan.klug@ideasonboard.com>\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\nChanges since v2:\n\n- Update commit message\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": [ "v3", "06/10" ] }