Patch Detail
Show a patch.
GET /api/1.1/patches/20956/?format=api
{ "id": 20956, "url": "https://patchwork.libcamera.org/api/1.1/patches/20956/?format=api", "web_url": "https://patchwork.libcamera.org/patch/20956/", "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": "<20240819160921.468981-8-dan.scally@ideasonboard.com>", "date": "2024-08-19T16:09:21", "name": "[v3,7/7] Documentation: Rework index.rst", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "149b360147fea971e12aa3a934de731723508bb0", "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/20956/mbox/", "series": [ { "id": 4527, "url": "https://patchwork.libcamera.org/api/1.1/series/4527/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4527", "date": "2024-08-19T16:09:14", "name": "Documentation improvements", "version": 3, "mbox": "https://patchwork.libcamera.org/series/4527/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/20956/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/20956/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 C54C5BDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tMon, 19 Aug 2024 16:09:54 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0A355633CF;\n\tMon, 19 Aug 2024 18:09:52 +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 A6646633C2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 19 Aug 2024 18:09:37 +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 403CA5A5;\n\tMon, 19 Aug 2024 18:08:36 +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=\"Srw13up4\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724083716;\n\tbh=5rjo2xdKLu6VuPTmo2St4bV/3eS8o3vPgomy2OfWJGY=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=Srw13up4OKKpo0jxe909TfPLEAJyBIIsfk6IFfezK6g1pEHXObOQc3ut2H2HJICgP\n\t5JbrxlDE7HQZEyRl9EbDu2Y8Ms5ZeJo61L6og888OIJ6nr+6t60cONqJwdXUbipcVW\n\t0IZTD58UZZVHZ7l9c01oCV0UmYR2zFL9pF8PfbXU=", "From": "Daniel Scally <dan.scally@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Daniel Scally <dan.scally@ideasonboard.com>,\n\tLaurent Pinchart <laurent.pinchart@ideasonboard.com>", "Subject": "[PATCH v3 7/7] Documentation: Rework index.rst", "Date": "Mon, 19 Aug 2024 17:09:21 +0100", "Message-Id": "<20240819160921.468981-8-dan.scally@ideasonboard.com>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20240819160921.468981-1-dan.scally@ideasonboard.com>", "References": "<20240819160921.468981-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": "index.rst is the page that becomes index.html, but currently just has\nsome blurb. Although this page will only be seen if viewing the docs\nas built from the libcamera tree it'd be better if it were more of an\nintroductory page. Include the content of docs.rst to improve it. As\nwe're no longer including the content from README.rst the labels that\nenabled that can be dropped.\n\nWith this change whether viewing the documentation as built in the\nlibcamera tree or on the Docs page of the website, the landing content\nwill be the same.\n\nThe CSS for the documentation's theme currently hides the toctree from\nthe generated body in html, as it's already displayed on every page via\nthe theme's CSS. This change reorders the page such that the CSS that\nhides the toctree no longer works - update the CSS to retain the\ncurrent behaviour.\n\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\nSigned-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n---\nChanges since v2:\n\n\t- None\n\nChanges since v1:\n\n\t- Removed superfluous comments\n\t- Expanded commit message\n\n Documentation/index.rst | 11 ++++++-----\n Documentation/theme/static/css/theme.css | 2 +-\n README.rst | 3 ---\n 3 files changed, 7 insertions(+), 9 deletions(-)", "diff": "diff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 3a790352..bea40660 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -1,16 +1,12 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n-.. Front page matter is defined in the project README file.\n-.. include:: ../README.rst\n- :start-after: .. section-begin-libcamera\n- :end-before: .. section-end-libcamera\n+.. include:: introduction.rst\n \n .. toctree::\n :maxdepth: 1\n :caption: Contents:\n \n Home <self>\n- Introduction <introduction>\n Contribute <contributing>\n Getting Started <getting-started>\n \n@@ -26,3 +22,8 @@\n Sensor driver requirements <sensor_driver_requirements>\n SoftwareISP Benchmarking <software-isp-benchmarking>\n Tracing guide <guides/tracing>\n+\n+.. toctree::\n+ :hidden:\n+\n+ introduction\n\\ No newline at end of file\ndiff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\nindex 2b1ed095..a6d43195 100644\n--- a/Documentation/theme/static/css/theme.css\n+++ b/Documentation/theme/static/css/theme.css\n@@ -283,7 +283,7 @@ div#signature {\n \tfont-size: 12px;\n }\n \n-#libcamera div.toctree-wrapper {\n+#licensing div.toctree-wrapper {\n \theight: 0px;\n \tmargin: 0px;\n \tpadding: 0px;\ndiff --git a/README.rst b/README.rst\nindex 92f16502..4068c6cc 100644\n--- a/README.rst\n+++ b/README.rst\n@@ -1,7 +1,5 @@\n .. SPDX-License-Identifier: CC-BY-SA-4.0\n \n-.. section-begin-libcamera\n-\n ===========\n libcamera\n ===========\n@@ -22,7 +20,6 @@ open-source-friendly while still protecting vendor core IP. libcamera was born\n out of that collaboration and will offer modern camera support to Linux-based\n systems, including traditional Linux distributions, ChromeOS and Android.\n \n-.. section-end-libcamera\n .. section-begin-getting-started\n \n Getting Started\n", "prefixes": [ "v3", "7/7" ] }