[libcamera-devel] [PATCH 3/3] Documentation: Link to the API documentation generated by Doxygen

Kieran Bingham kieran.bingham at ideasonboard.com
Fri Jan 11 13:16:45 CET 2019


Hi Laurent,

Thanks for posting this series. Lets get the patches in and then we can
tie the website to be generated from the sources soon.

--
Kieran.

On 10/01/2019 23:38, Laurent Pinchart wrote:
> Add a link in the toctree to the API documentation.
> 
> sphinx doesn't seem to support relative external links, but we can trick
> it into thinking the link is absolute by adding '#://' at the end.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

> ---
>  Documentation/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 3e089e69729c..a87509c24275 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -24,3 +24,4 @@ systems, including traditional Linux distributions, ChromeOS and Android.
>     Docs <docs>
>     Coding Style <coding-style>
>     Contribute <contributing>
> +   API <../api-html/index.html#://>
> 

-- 
Regards
--
Kieran


More information about the libcamera-devel mailing list