[libcamera-devel] [PATCH] Documentation: Add getting started section

[Kieran Bingham]

Hi Laurent,

On 23/03/2021 11:35, Laurent Pinchart wrote:
> Pull the "getting started" of README.rst in the documentation tree, as
> done on libcamera.org, to ensure documentation build coverage of the
> whole README.rst.

This sounds like a useful thing to do.

Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> ---
>  Documentation/getting-started.rst | 4 ++++
>  Documentation/index.rst           | 1 +
>  2 files changed, 5 insertions(+)
>  create mode 100644 Documentation/getting-started.rst
> 
> diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst
> new file mode 100644
> index 000000000000..4cc34a176fe6
> --- /dev/null
> +++ b/Documentation/getting-started.rst
> @@ -0,0 +1,4 @@
> +.. Getting started information is defined in the project README file.
> +.. include:: ../README.rst
> +   :start-after: .. section-begin-getting-started
> +   :end-before: .. section-end-getting-started
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 285ca7c3e5ae..7e3fe2f6e785 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -12,6 +12,7 @@
>     Home <self>
>     Docs <docs>
>     Contribute <contributing>
> +   Getting Started <getting-started>
>  
>     Developer Guide <guides/introduction>
>     Application Writer's Guide <guides/application-developer>
> 

-- 
Regards
--
Kieran