| Message ID | 20191021102453.26471-3-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Commit | dd84815d61fe8c306ac799985ae9f2683741c49a |
| Headers | show |
| Series |
|
| Related | show |
Hi Laurent, On 21/10/2019 11:24, Laurent Pinchart wrote: > The API belongs to the docs section. Link to it from docs.rst, and > remove the shortcut in the navigation bar as links to a placeholder > only. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> I feel like we should just remove references to the API from the source built version - and add this to our site wrapper (even keeping it as just a top level navigation link) But if you want to keep this patch, I have no real objections: Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> > --- > Documentation/api-html/index.rst | 2 ++ > Documentation/docs.rst | 12 ++++++++++++ > Documentation/index.rst | 1 - > 3 files changed, 14 insertions(+), 1 deletion(-) > > diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst > index dbaaad1552b6..cf2ef0bb38af 100644 > --- a/Documentation/api-html/index.rst > +++ b/Documentation/api-html/index.rst > @@ -1,3 +1,5 @@ > +.. _api: > + > API > === Hrm... it would be nice if we could get rid of this place holder altogether. As in the source tree we can't reference the separate build anyway, I wonder if there's a simple way to remove this placeholder, and just keep references to the API links in the web-page generated version? > diff --git a/Documentation/docs.rst b/Documentation/docs.rst > index cc621a49f412..7a3977c13110 100644 > --- a/Documentation/docs.rst > +++ b/Documentation/docs.rst > @@ -2,6 +2,18 @@ > Documentation > ************* > > +.. toctree:: > + :hidden: > + > + API <api-html/index> > + > +API > +=== > + > +The libcamera API is extensively documented using Doxygen. The :ref:`API > +nightly build <api>` contains the most up-to-date API documentation, built from > +the latest master branch. > + > Feature Requirements > ==================== > > diff --git a/Documentation/index.rst b/Documentation/index.rst > index 84d5f6a88caf..bbce717edd0e 100644 > --- a/Documentation/index.rst > +++ b/Documentation/index.rst > @@ -8,4 +8,3 @@ > Home <self> > Docs <docs> > Contribute <contributing> > - API <api-html/index> >
diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst index dbaaad1552b6..cf2ef0bb38af 100644 --- a/Documentation/api-html/index.rst +++ b/Documentation/api-html/index.rst @@ -1,3 +1,5 @@ +.. _api: + API === diff --git a/Documentation/docs.rst b/Documentation/docs.rst index cc621a49f412..7a3977c13110 100644 --- a/Documentation/docs.rst +++ b/Documentation/docs.rst @@ -2,6 +2,18 @@ Documentation ************* +.. toctree:: + :hidden: + + API <api-html/index> + +API +=== + +The libcamera API is extensively documented using Doxygen. The :ref:`API +nightly build <api>` contains the most up-to-date API documentation, built from +the latest master branch. + Feature Requirements ==================== diff --git a/Documentation/index.rst b/Documentation/index.rst index 84d5f6a88caf..bbce717edd0e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -8,4 +8,3 @@ Home <self> Docs <docs> Contribute <contributing> - API <api-html/index>
The API belongs to the docs section. Link to it from docs.rst, and remove the shortcut in the navigation bar as links to a placeholder only. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- Documentation/api-html/index.rst | 2 ++ Documentation/docs.rst | 12 ++++++++++++ Documentation/index.rst | 1 - 3 files changed, 14 insertions(+), 1 deletion(-)