[libcamera-devel] [PATCH 3/8] Documentation: Link to API section in Docs
Laurent Pinchart
laurent.pinchart at ideasonboard.com
Mon Oct 21 12:24:48 CEST 2019
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 at 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
===
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>
--
Regards,
Laurent Pinchart
More information about the libcamera-devel
mailing list