[2/2] Documentation: Fix links from API references to guides
diff mbox series

Message ID 20240822081607.911049-3-dan.scally@ideasonboard.com
State Accepted
Commit 874b63d5cb3f772d361ce891721e7580b09dd378
Headers show
Series
  • Fixed Documentation links
Related show

Commit Message

Daniel Scally Aug. 22, 2024, 8:16 a.m. UTC
The links on the API reference mainpage to guides within the main
libcamera documentation work built locally, but not through the
website. As the website's more important make them work with the
website paths as a temporary solution until a better one is devised.

Fixes: e9388617 ("Documentation: Improve doxygen main page")
Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
---
 Documentation/mainpage.dox | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Laurent Pinchart Aug. 25, 2024, 1:28 a.m. UTC | #1
Hi Dan,

Thank you for the patch.

On Thu, Aug 22, 2024 at 09:16:07AM +0100, Daniel Scally wrote:
> The links on the API reference mainpage to guides within the main
> libcamera documentation work built locally, but not through the
> website. As the website's more important make them work with the
> website paths as a temporary solution until a better one is devised.

Yeah, more work to do :S If only everybody read documentation in source
format in a text editor instead of a web browser...

> Fixes: e9388617 ("Documentation: Improve doxygen main page")
> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>

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

> ---
>  Documentation/mainpage.dox | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox
> index d04d932f..cbee9bab 100644
> --- a/Documentation/mainpage.dox
> +++ b/Documentation/mainpage.dox
> @@ -12,8 +12,8 @@ library's concepts.
>  \if internal
>  
>  As a follow-on to the developer's guide, to assist you in adding support for
> -your platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html)
> -and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful.
> +your platform the [pipeline handler writer's guide](../guides/pipeline-handler.html)
> +and the [ipa module writer's guide](../guides/ipa.html) should be helpful.
>  
>  The full libcamera API is documented here. If you wish to see only the public
>  part of the API you can use [these pages](../api-html/index.html) instead.
> @@ -21,7 +21,7 @@ part of the API you can use [these pages](../api-html/index.html) instead.
>  \else
>  
>  As a follow-on to the developer's guide, to assist you in using libcamera within
> -your project the [application developer's guide](../html/guides/application-developer.html)
> +your project the [application developer's guide](../guides/application-developer.html)
>  gives an overview on how to achieve that.
>  
>  Only the public part of the libcamera API is documented here; if you are a

Patch
diff mbox series

diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox
index d04d932f..cbee9bab 100644
--- a/Documentation/mainpage.dox
+++ b/Documentation/mainpage.dox
@@ -12,8 +12,8 @@  library's concepts.
 \if internal
 
 As a follow-on to the developer's guide, to assist you in adding support for
-your platform the [pipeline handler writer's guide](../html/guides/pipeline-handler.html)
-and the [ipa module writer's guide](../html/guides/ipa.html) should be helpful.
+your platform the [pipeline handler writer's guide](../guides/pipeline-handler.html)
+and the [ipa module writer's guide](../guides/ipa.html) should be helpful.
 
 The full libcamera API is documented here. If you wish to see only the public
 part of the API you can use [these pages](../api-html/index.html) instead.
@@ -21,7 +21,7 @@  part of the API you can use [these pages](../api-html/index.html) instead.
 \else
 
 As a follow-on to the developer's guide, to assist you in using libcamera within
-your project the [application developer's guide](../html/guides/application-developer.html)
+your project the [application developer's guide](../guides/application-developer.html)
 gives an overview on how to achieve that.
 
 Only the public part of the libcamera API is documented here; if you are a