Patch Detail
Show a patch.
GET /api/1.1/patches/20862/?format=api
{ "id": 20862, "url": "https://patchwork.libcamera.org/api/1.1/patches/20862/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20862/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/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": "<20240809145304.537551-2-dan.scally@ideasonboard.com>", "date": "2024-08-09T14:52:58", "name": "[1/7] Documentation: Add documentation-contents.rst", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "66824c63f74244c8b82a807864820ed38ddd5827", "submitter": { "id": 156, "url": "https://patchwork.libcamera.org/api/1.1/people/156/?format=api", "name": "Dan Scally", "email": "dan.scally@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/20862/mbox/", "series": [ { "id": 4507, "url": "https://patchwork.libcamera.org/api/1.1/series/4507/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4507", "date": "2024-08-09T14:52:57", "name": "Documentation improvements", "version": 1, "mbox": "https://patchwork.libcamera.org/series/4507/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20862/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20862/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 E0BDDC323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 9 Aug 2024 14:53:25 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 50952633C0;\n\tFri, 9 Aug 2024 16:53:23 +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 060E063398\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 9 Aug 2024 16:53:20 +0200 (CEST)", "from mail.ideasonboard.com\n\t(cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 97DAFB7E;\n\tFri, 9 Aug 2024 16:52:25 +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=\"Kch/78cI\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1723215145;\n\tbh=b7xl/mR/jDlM4cBd9NoJba08NsUo/camvLmsPirj5Vs=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=Kch/78cIaJgGZ4/OfySeYsKFo5IQTfJDlsP450RQTYue+3I+7qASYAlQCw4xD9Zm/\n\tPYAMpvyN778nCBixRVCiRNuw+23sJuW+MYE2nsV7Ug05nCG2rFvWfPHniF1hwO5418\n\tr+9OCrAzC3w3axomAoGwreBzwbwhoTFKBZjMGF1M=", "From": "Daniel Scally <dan.scally@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Daniel Scally <dan.scally@ideasonboard.com>", "Subject": "[PATCH 1/7] Documentation: Add documentation-contents.rst", "Date": "Fri, 9 Aug 2024 15:52:58 +0100", "Message-Id": "<20240809145304.537551-2-dan.scally@ideasonboard.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240809145304.537551-1-dan.scally@ideasonboard.com>", "References": "<20240809145304.537551-1-dan.scally@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": "Add a new .rst file referencing the documentation contents. This file\nis then included in each documentation page so that we can enhance\nthe Documentation pages on the libcamera website using it. As we do\nnot want the appearance of the libcamera in-tree Documentation to\nchange just yet, disable the new class using the sphinx theme's CSS.\n\nSigned-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n---\n Documentation/camera-sensor-model.rst | 2 ++\n Documentation/code-of-conduct.rst | 2 ++\n Documentation/coding-style.rst | 2 ++\n Documentation/conf.py | 7 ++++++-\n Documentation/docs.rst | 2 ++\n Documentation/documentation-contents.rst | 20 +++++++++++++++++++\n Documentation/environment_variables.rst | 2 ++\n Documentation/getting-started.rst | 1 +\n .../guides/application-developer.rst | 2 ++\n Documentation/guides/introduction.rst | 2 ++\n Documentation/guides/ipa.rst | 2 ++\n Documentation/guides/pipeline-handler.rst | 2 ++\n Documentation/guides/tracing.rst | 2 ++\n Documentation/lens_driver_requirements.rst | 2 ++\n Documentation/python-bindings.rst | 2 ++\n Documentation/sensor_driver_requirements.rst | 2 ++\n Documentation/software-isp-benchmarking.rst | 2 ++\n Documentation/theme/static/css/theme.css | 4 ++++\n 18 files changed, 59 insertions(+), 1 deletion(-)\n create mode 100644 Documentation/documentation-contents.rst", "diff": "diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\nindex b66c880a..87a25bf4 100644\n--- a/Documentation/camera-sensor-model.rst\n+++ b/Documentation/camera-sensor-model.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _camera-sensor-model:\n \n .. todo: Move to Doxygen-generated documentation\ndiff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst\nindex 38b7d7ad..0edd1e99 100644\n--- a/Documentation/code-of-conduct.rst\n+++ b/Documentation/code-of-conduct.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _code-of-conduct:\n \n Contributor Covenant Code of Conduct\ndiff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\nindex 72cb28d2..ae8446bd 100644\n--- a/Documentation/coding-style.rst\n+++ b/Documentation/coding-style.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _coding-style-guidelines:\n \n Coding Style Guidelines\ndiff --git a/Documentation/conf.py b/Documentation/conf.py\nindex 7eeea7f3..ca817aab 100644\n--- a/Documentation/conf.py\n+++ b/Documentation/conf.py\n@@ -61,7 +61,12 @@ language = 'en'\n # List of patterns, relative to source directory, that match files and\n # directories to ignore when looking for source files.\n # This pattern also affects html_static_path and html_extra_path.\n-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n+exclude_patterns = [\n+ '_build',\n+ 'Thumbs.db',\n+ '.DS_Store',\n+ 'documentation-contents.rst',\n+ ]\n \n # The name of the Pygments (syntax highlighting) style to use.\n pygments_style = None\ndiff --git a/Documentation/docs.rst b/Documentation/docs.rst\nindex a6e8a59a..5871961c 100644\n--- a/Documentation/docs.rst\n+++ b/Documentation/docs.rst\n@@ -3,6 +3,8 @@\n .. contents::\n :local:\n \n+.. include:: documentation-contents.rst\n+\n *************\n Documentation\n *************\ndiff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\nnew file mode 100644\nindex 00000000..e9a3846b\n--- /dev/null\n+++ b/Documentation/documentation-contents.rst\n@@ -0,0 +1,20 @@\n+.. SPDX-License-Identifier: CC-BY-SA-4.0\n+\n+.. container:: documentation-nav\n+\n+ * :doc:`/api-html/index`\n+ * :doc:`/camera-sensor-model`\n+ * :doc:`/code-of-conduct`\n+ * :doc:`/coding-style`\n+ * :doc:`/environment_variables`\n+ * :doc:`/guides/application-developer`\n+ * :doc:`/guides/introduction`\n+ * :doc:`/guides/ipa`\n+ * :doc:`/guides/pipeline-handler`\n+ * :doc:`/guides/tracing`\n+ * :doc:`/lens_driver_requirements`\n+ * :doc:`/python-bindings`\n+ * :doc:`/sensor_driver_requirements`\n+ * :doc:`/software-isp-benchmarking`\n+\n+.. rst-class:: documentation\ndiff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\nindex 4e9fbb27..1478275b 100644\n--- a/Documentation/environment_variables.rst\n+++ b/Documentation/environment_variables.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n Environment variables\n =====================\n \ndiff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst\nindex 987f43f7..63b050eb 100644\n--- a/Documentation/getting-started.rst\n+++ b/Documentation/getting-started.rst\n@@ -1,4 +1,5 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n+\n .. Getting started information is defined in the project README file.\n .. include:: ../README.rst\n :start-after: .. section-begin-getting-started\ndiff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\nindex 92e2a373..1ea8c40f 100644\n--- a/Documentation/guides/application-developer.rst\n+++ b/Documentation/guides/application-developer.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: ../documentation-contents.rst\n+\n Using libcamera in a C++ application\n ====================================\n \ndiff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\nindex 700ec2d3..8368bd4a 100644\n--- a/Documentation/guides/introduction.rst\n+++ b/Documentation/guides/introduction.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: ../documentation-contents.rst\n+\n Developers guide to libcamera\n =============================\n \ndiff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst\nindex 25deadef..cd640563 100644\n--- a/Documentation/guides/ipa.rst\n+++ b/Documentation/guides/ipa.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: ../documentation-contents.rst\n+\n IPA Writer's Guide\n ==================\n \ndiff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\nindex 7e45cdb8..efa89342 100644\n--- a/Documentation/guides/pipeline-handler.rst\n+++ b/Documentation/guides/pipeline-handler.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: ../documentation-contents.rst\n+\n Pipeline Handler Writers Guide\n ==============================\n \ndiff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst\nindex ae960d85..537dce50 100644\n--- a/Documentation/guides/tracing.rst\n+++ b/Documentation/guides/tracing.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: ../documentation-contents.rst\n+\n Tracing Guide\n =============\n \ndiff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\nindex b96e502d..85fef76f 100644\n--- a/Documentation/lens_driver_requirements.rst\n+++ b/Documentation/lens_driver_requirements.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _lens-driver-requirements:\n \n Lens Driver Requirements\ndiff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\nindex ed9f686b..94712238 100644\n--- a/Documentation/python-bindings.rst\n+++ b/Documentation/python-bindings.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _python-bindings:\n \n Python Bindings for libcamera\ndiff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\nindex 0e516b34..fb4269d0 100644\n--- a/Documentation/sensor_driver_requirements.rst\n+++ b/Documentation/sensor_driver_requirements.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _sensor-driver-requirements:\n \n Sensor Driver Requirements\ndiff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\nindex b3033132..9c2a409b 100644\n--- a/Documentation/software-isp-benchmarking.rst\n+++ b/Documentation/software-isp-benchmarking.rst\n@@ -1,5 +1,7 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n+.. include:: documentation-contents.rst\n+\n .. _software-isp-benchmarking:\n \n Software ISP benchmarking\ndiff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\nindex d4274ea6..2b1ed095 100644\n--- a/Documentation/theme/static/css/theme.css\n+++ b/Documentation/theme/static/css/theme.css\n@@ -289,3 +289,7 @@ div#signature {\n \tpadding: 0px;\n \tvisibility: hidden;\n }\n+\n+.documentation-nav {\n+\tdisplay: none;\n+}\n", "prefixes": [ "1/7" ] }