[2/6] documentation: Enable doxygen-awesome-css
diff mbox series

Message ID 20250908140803.123272-3-stefan.klug@ideasonboard.com
State New
Headers show
Series
  • Documentation theming update
Related show

Commit Message

Stefan Klug Sept. 8, 2025, 2:07 p.m. UTC
Include doxygen-awesome-css in the doxygen config.

Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
---
 Documentation/Doxyfile-common.in | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Laurent Pinchart Sept. 8, 2025, 6:54 p.m. UTC | #1
Hi Stefan,

Thank you for the patch.

On Mon, Sep 08, 2025 at 04:07:45PM +0200, Stefan Klug wrote:
> Include doxygen-awesome-css in the doxygen config.
> 
> Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
> ---
>  Documentation/Doxyfile-common.in | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
> index 58afea1cd70d..a1c8523ede78 100644
> --- a/Documentation/Doxyfile-common.in
> +++ b/Documentation/Doxyfile-common.in
> @@ -69,3 +69,8 @@ PREDEFINED             = __DOXYGEN__ \
>  			 @PREDEFINED@
>  
>  HAVE_DOT               = YES
> +
> +GENERATE_TREEVIEW      = YES

Please explain in the commit message why you enable this option.

> +HTML_EXTRA_STYLESHEET  = "@CURRENT_SRCDIR@/doxygen-awesome-css/doxygen-awesome.css" \
> +                         "@CURRENT_SRCDIR@/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
> +HTML_COLORSTYLE        = LIGHT # required with Doxygen >= 1.9.5

Required by what, doxygen-awesome-css or something else ? AUTO_LIGHT
doesn't work ?

I've just sent "[PATCH] Documentation: Use standard ordering for
Doxyfile variables". Unless the patch is considered as too pedantic and
rejected, please insert the new variables in the appropriate location.

Patch
diff mbox series

diff --git a/Documentation/Doxyfile-common.in b/Documentation/Doxyfile-common.in
index 58afea1cd70d..a1c8523ede78 100644
--- a/Documentation/Doxyfile-common.in
+++ b/Documentation/Doxyfile-common.in
@@ -69,3 +69,8 @@  PREDEFINED             = __DOXYGEN__ \
 			 @PREDEFINED@
 
 HAVE_DOT               = YES
+
+GENERATE_TREEVIEW      = YES
+HTML_EXTRA_STYLESHEET  = "@CURRENT_SRCDIR@/doxygen-awesome-css/doxygen-awesome.css" \
+                         "@CURRENT_SRCDIR@/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
+HTML_COLORSTYLE        = LIGHT # required with Doxygen >= 1.9.5