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

Message ID 20190110233829.9638-4-laurent.pinchart@ideasonboard.com
State Accepted
Commit c8e2c5adda95f3be0354a832268539f7314afb5e
Headers show
Series
  • Generate libcamera.org website from documentation
Related show

Commit Message

Laurent Pinchart Jan. 10, 2019, 11:38 p.m. UTC
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@ideasonboard.com>
---
 Documentation/index.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Kieran Bingham Jan. 11, 2019, 12:16 p.m. UTC | #1
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@ideasonboard.com>

Reviewed-by: Kieran Bingham <kieran.bingham@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#://>
>

Patch

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#://>