From patchwork Mon Oct 21 10:24:51 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 2204 Return-Path: Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 13B6060BE0 for ; Mon, 21 Oct 2019 12:25:08 +0200 (CEST) Received: from pendragon.ideasonboard.com (143.121.2.93.rev.sfr.net [93.2.121.143]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 5A2E3B60 for ; Mon, 21 Oct 2019 12:25:07 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1571653507; bh=qswvO/I44xdZq45UTopwEsOZ07PmoHAKyOF1zjDo/08=; h=From:To:Subject:Date:In-Reply-To:References:From; b=WLfPdiZQlBJ7YZmPEtYA6cdpcuof4tV2C9UwRiupltpzVYs9Y2ejIuip6G0q/tHqE T/d4bgITnhV1QlatCyAlin14IlwKj22gWFtG/OHgbMNMP8aj8kFSm7a74XLL0XBMsn YjQ4cvDWtJo+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 Subject: [libcamera-devel] [PATCH 6/8] Documentation: Hide the Getting Started information X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 21 Oct 2019 10:25:09 -0000 The Getting Started information makes little sense on the generated documentation, as a developer with documentation compiled from a local libcamera source tree has already got started. We however want to keep the information in the top-level README.rst as it is useful there. In order to hide the Getting Started information from the front page while keeping it in README.rst, add comments to delimitate sections of README.rst, and include only a subset of the file in the front page. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham --- Documentation/index.rst | 2 ++ README.rst | 9 ++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index 28267cec36b7..2c84a5401506 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,5 +1,7 @@ .. Front page matter is defined in the project README file. .. include:: ../README.rst + :start-after: .. section-begin-libcamera + :end-before: .. section-end-libcamera .. toctree:: :maxdepth: 1 diff --git a/README.rst b/README.rst index 2ccf7cbec40a..220ebdb17a42 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,5 @@ +.. section-begin-libcamera + =========== libcamera =========== @@ -18,6 +20,9 @@ open-source-friendly while still protecting vendor core IP. libcamera was born out of that collaboration and will offer modern camera support to Linux-based systems, including traditional Linux distributions, ChromeOS and Android. +.. section-end-libcamera +.. section-begin-getting-started + Getting Started --------------- @@ -31,7 +36,7 @@ To build and install: ninja install Dependencies ------------- +~~~~~~~~~~~~ The following Debian/Ubuntu packages are required for building libcamera. Other distributions may have differing package names: @@ -50,3 +55,5 @@ for qcam: [optional] for documentation: [optional] python3-sphinx doxygen + +.. section-end-getting-started