{"id":2204,"url":"https://patchwork.libcamera.org/api/patches/2204/?format=json","web_url":"https://patchwork.libcamera.org/patch/2204/","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":"<20191021102453.26471-6-laurent.pinchart@ideasonboard.com>","date":"2019-10-21T10:24:51","name":"[libcamera-devel,6/8] Documentation: Hide the Getting Started information","commit_ref":"cf596d8dfa7a41b7d5979cc832bec6f9c8322bd8","pull_url":null,"state":"accepted","archived":false,"hash":"7f700b0493caf053e5f6de0edf85bcb296e008f0","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/2204/mbox/","series":[{"id":539,"url":"https://patchwork.libcamera.org/api/series/539/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=539","date":"2019-10-21T10:24:46","name":"[libcamera-devel,1/8] Documentation: Move coding style under contributing","version":1,"mbox":"https://patchwork.libcamera.org/series/539/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2204/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2204/checks/","tags":{},"headers":{"Return-Path":"","Received":["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 13B6060BE0\n\tfor ;\n\tMon, 21 Oct 2019 12:25:08 +0200 (CEST)","from pendragon.ideasonboard.com (143.121.2.93.rev.sfr.net\n\t[93.2.121.143])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5A2E3B60\n\tfor ;\n\tMon, 21 Oct 2019 12:25:07 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1571653507;\n\tbh=qswvO/I44xdZq45UTopwEsOZ07PmoHAKyOF1zjDo/08=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=WLfPdiZQlBJ7YZmPEtYA6cdpcuof4tV2C9UwRiupltpzVYs9Y2ejIuip6G0q/tHqE\n\tT/d4bgITnhV1QlatCyAlin14IlwKj22gWFtG/OHgbMNMP8aj8kFSm7a74XLL0XBMsn\n\tYjQ4cvDWtJo+fy+lKqH/6bSh2SctWyIz8CgOxef0=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Date":"Mon, 21 Oct 2019 13:24:51 +0300","Message-Id":"<20191021102453.26471-6-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.23.0","In-Reply-To":"<20191021102453.26471-1-laurent.pinchart@ideasonboard.com>","References":"<20191021102453.26471-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 6/8] Documentation: Hide the Getting\n\tStarted information","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","X-List-Received-Date":"Mon, 21 Oct 2019 10:25:09 -0000"},"content":"The Getting Started information makes little sense on the generated\ndocumentation, as a developer with documentation compiled from a local\nlibcamera source tree has already got started. We however want to keep\nthe information in the top-level README.rst as it is useful there.\n\nIn order to hide the Getting Started information from the front page\nwhile keeping it in README.rst, add comments to delimitate sections of\nREADME.rst, and include only a subset of the file in the front page.\n\nSigned-off-by: Laurent Pinchart \n---\n Documentation/index.rst | 2 ++\n README.rst | 9 ++++++++-\n 2 files changed, 10 insertions(+), 1 deletion(-)","diff":"diff --git a/Documentation/index.rst b/Documentation/index.rst\nindex 28267cec36b7..2c84a5401506 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -1,5 +1,7 @@\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 \n .. toctree::\n :maxdepth: 1\ndiff --git a/README.rst b/README.rst\nindex 2ccf7cbec40a..220ebdb17a42 100644\n--- a/README.rst\n+++ b/README.rst\n@@ -1,3 +1,5 @@\n+.. section-begin-libcamera\n+\n ===========\n libcamera\n ===========\n@@ -18,6 +20,9 @@ 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 ---------------\n \n@@ -31,7 +36,7 @@ To build and install:\n ninja install\n \n Dependencies\n-------------\n+~~~~~~~~~~~~\n \n The following Debian/Ubuntu packages are required for building libcamera.\n Other distributions may have differing package names:\n@@ -50,3 +55,5 @@ for qcam: [optional]\n \n for documentation: [optional]\n \tpython3-sphinx doxygen\n+\n+.. section-end-getting-started\n","prefixes":["libcamera-devel","6/8"]}