diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-10-17 03:49:33 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-10-23 17:41:09 +0300 |
| commit | dd84815d61fe8c306ac799985ae9f2683741c49a (patch) | |
| tree | 38fc2f69fb161f6911d79d41adc21147ad464612 /Documentation | |
| parent | bbc3be2fb5324aaef03101ff1b3ce26cae1b3edb (diff) | |
Documentation: Link to API section in Docs
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/api-html/index.rst | 2 | ||||
| -rw-r--r-- | Documentation/docs.rst | 12 | ||||
| -rw-r--r-- | Documentation/index.rst | 1 |
3 files changed, 14 insertions, 1 deletions
diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst index dbaaad15..cf2ef0bb 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 cc621a49..7a3977c1 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 84d5f6a8..bbce717e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -8,4 +8,3 @@ Home <self> Docs <docs> Contribute <contributing> - API <api-html/index> |