[PATCH v4 8/9] Documentation: Add internal-api-html placeholder

Daniel Scally dan.scally at ideasonboard.com
Tue Aug 20 15:07:39 CEST 2024


Mimicing the existing api-html placeholder, add a placeholder for the
internal version of the Doxygen generated API documentation so that
the website can generate hyperlinks to it properly.

Signed-off-by: Daniel Scally <dan.scally at ideasonboard.com>
---
Changes since v3:

	- New patch

 Documentation/documentation-contents.rst  | 1 +
 Documentation/internal-api-html/index.rst | 8 ++++++++
 Documentation/introduction.rst            | 1 +
 3 files changed, 10 insertions(+)
 create mode 100644 Documentation/internal-api-html/index.rst

diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst
index c14389bc..912b13f3 100644
--- a/Documentation/documentation-contents.rst
+++ b/Documentation/documentation-contents.rst
@@ -3,6 +3,7 @@
 .. container:: documentation-nav
 
    * :doc:`/api-html/index`
+   * :doc:`/internal-api-html/index`
    * :doc:`/camera-sensor-model`
    * :doc:`/code-of-conduct`
    * :doc:`/coding-style`
diff --git a/Documentation/internal-api-html/index.rst b/Documentation/internal-api-html/index.rst
new file mode 100644
index 00000000..0044a2d1
--- /dev/null
+++ b/Documentation/internal-api-html/index.rst
@@ -0,0 +1,8 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. _internal-api:
+
+Internal API
+============
+
+:: Placeholder for Doxygen documentation
diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst
index 8f96c65f..5c64d08c 100644
--- a/Documentation/introduction.rst
+++ b/Documentation/introduction.rst
@@ -13,6 +13,7 @@ Documentation
    :hidden:
 
    API <api-html/index>
+   Internal API <internal-api-html/index>
 
 What is libcamera?
 ==================
-- 
2.34.1



More information about the libcamera-devel mailing list