From 66a59d9666057dfe90aa2024dad4ba41f407a1f7 Mon Sep 17 00:00:00 2001 From: Benedikt Galbavy Date: Fri, 2 Feb 2024 20:13:06 +0100 Subject: [PATCH] adjusted theme --- .gitmodules | 3 ++ Doxyfile | 18 ++++--- docs/custom.css | 54 +++++++++++++++++++ docs/doxygen-awesome-css | 1 + docs/header.html | 110 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 180 insertions(+), 6 deletions(-) create mode 100644 docs/custom.css create mode 160000 docs/doxygen-awesome-css create mode 100644 docs/header.html diff --git a/.gitmodules b/.gitmodules index bfa520c..a0c91fc 100644 --- a/.gitmodules +++ b/.gitmodules @@ -14,3 +14,6 @@ path = extern/SDL_ttf url = https://github.com/libsdl-org/SDL_ttf.git branch = release-2.22.x +[submodule "docs/doxygen-awesome-css"] + path = docs/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/Doxyfile b/Doxyfile index 1709b68..d90e875 100644 --- a/Doxyfile +++ b/Doxyfile @@ -858,7 +858,7 @@ WARNINGS = YES # will automatically be disabled. # The default value is: YES. -WARN_IF_UNDOCUMENTED = YES +WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as documenting some parameters in @@ -1281,7 +1281,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = docs/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1321,7 +1321,10 @@ HTML_STYLESHEET = # documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = docs/doxygen-awesome-css/doxygen-awesome.css \ + docs/doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + docs/doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css \ + docs/custom.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1331,7 +1334,10 @@ HTML_EXTRA_STYLESHEET = # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ + docs/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \ + docs/doxygen-awesome-css/doxygen-awesome-paragraph-link.js \ + docs/doxygen-awesome-css/doxygen-awesome-interactive-toc.js # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. @@ -1344,7 +1350,7 @@ HTML_EXTRA_FILES = # The default value is: AUTO_LIGHT. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_COLORSTYLE = AUTO_LIGHT +HTML_COLORSTYLE = LIGHT # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to @@ -1655,7 +1661,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = YES +DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag diff --git a/docs/custom.css b/docs/custom.css new file mode 100644 index 0000000..720b3bd --- /dev/null +++ b/docs/custom.css @@ -0,0 +1,54 @@ +html { + /* primary theme color. This will affect the entire websites color scheme: links, arrows, labels, ... */ + --primary-color: #bd93f9; + --primary-dark-color: #9270e4; + --primary-light-color: #9270e4; + + /* page base colors */ + --page-background-color: #ffffff; + --page-foreground-color: #2f4153; + --page-secondary-foreground-color: #6f7e8e; + + /* color for all separators on the website: hr, borders, ... */ + --separator-color: #bd93f965; + + /* border radius for all rounded components. Will affect many components, like dropdowns, memitems, codeblocks, ... */ + --border-radius-large: 22px; + --border-radius-small: 9px; + --border-radius-medium: 14px; + + /* default spacings. Most components reference these values for spacing, to provide uniform spacing on the page. */ + --spacing-small: 8px; + --spacing-medium: 14px; + --spacing-large: 19px; + + --top-height: 125px; + + ... +} + +html.dark-mode { + color-scheme: dark; + + --primary-color: #bd93f9; + --primary-dark-color: #9270e4; + --primary-light-color: #9270e4; + --primary-lighter-color: #191e21; + --primary-lightest-color: #191a1c; + + --page-background-color: #21222c; + --page-foreground-color: #d2dbde; + --page-secondary-foreground-color: #859399; + --separator-color: #3a3246; + --side-nav-background: #282a36; + --side-nav-foreground: #f8f8f2; + --toc-background: #282A36; + --searchbar-background: var(--page-background-color); + + ... +} + +.paramname em { + font-weight: 600; + color: var(--primary-dark-color); +} \ No newline at end of file diff --git a/docs/doxygen-awesome-css b/docs/doxygen-awesome-css new file mode 160000 index 0000000..df88fe4 --- /dev/null +++ b/docs/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit df88fe4fdd97714fadfd3ef17de0b4401f804052 diff --git a/docs/header.html b/docs/header.html new file mode 100644 index 0000000..c342193 --- /dev/null +++ b/docs/header.html @@ -0,0 +1,110 @@ + + + + + + + + + + + $projectname: $title + + + $title + + + + + + + + + + + + + + + + + + + + + + + + $treeview + $search + $mathjax + $darkmode + + $extrastylesheet + + + + + +
+ + + +
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
$projectname +  $projectnumber + +
+ +
$projectbrief
+ + 		+
$projectbrief
+ 		$searchbox
$searchbox
+
+ + \ No newline at end of file