From cf596d8dfa7a41b7d5979cc832bec6f9c8322bd8 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Thu, 17 Oct 2019 02:53:30 +0300 Subject: Documentation: Hide the Getting Started information 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 --- README.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 2ccf7cbe..220ebdb1 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 -- cgit v1.2.1