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

[Laurent Pinchart]

Hi Dan,

Thank you for the patch.

On Tue, Aug 20, 2024 at 02:07:39PM +0100, Daniel Scally wrote:
> Mimicing the existing api-html placeholder, add a placeholder for the

s/Mimicing/Mimicking/

> 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

What if you named this "Internal API Reference" (and renamed "API" to
"API Reference" in the corresponding file, would that allow removing the
manual labels from Documentation/documentation-contents.rst in patch
9/9 ?

Reviewed-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

> +============
> +
> +:: 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?
>  ==================

-- 
Regards,

Laurent Pinchart