| Message ID | 20210323113542.8613-1-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Commit | ef2213fdb673bbc9b7ae9e62db83d6edaf824d5e |
| Delegated to: | Laurent Pinchart |
| Headers | show |
| Series |
|
| Related | show |
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@ideasonboard.com> > Signed-off-by: Laurent Pinchart <laurent.pinchart@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> >
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>
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. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- Documentation/getting-started.rst | 4 ++++ Documentation/index.rst | 1 + 2 files changed, 5 insertions(+) create mode 100644 Documentation/getting-started.rst