Docs: Fix logo url, added dark mode toggle and more stuff

sisoputnfrba · Aug 16, 2024 · d33d3e6 · d33d3e6
1 parent 949b6a0
commit d33d3e6
Show file tree

Hide file tree

Showing 16 changed files with 313 additions and 96 deletions.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -614,7 +614,7 @@ HIDE_COMPOUND_REFERENCE= NO
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
 
-SHOW_INCLUDE_FILES     = YES
+SHOW_INCLUDE_FILES     = NO
 
 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
 # grouped member an include statement to the documentation, telling the reader
@@ -1032,7 +1032,7 @@ USE_MDFILE_AS_MAINPAGE = README.md
 # also VERBATIM_HEADERS is set to NO.
 # The default value is: NO.
 
-SOURCE_BROWSER         = YES
+SOURCE_BROWSER         = NO
 
 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
 # classes and enums directly into the documentation.
@@ -1065,7 +1065,7 @@ REFERENCES_RELATION    = NO
 # link to the documentation.
 # The default value is: YES.
 
-REFERENCES_LINK_SOURCE = YES
+REFERENCES_LINK_SOURCE = NO
 
 # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
 # source code will show a tooltip with additional information such as prototype,
@@ -1241,7 +1241,8 @@ HTML_STYLESHEET        =
 # list). For an example see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = css/custom.css css/doxygen-awesome.css
+HTML_EXTRA_STYLESHEET  = css/doxygen-awesome.css \
+                         css/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
@@ -1251,7 +1252,7 @@ HTML_EXTRA_STYLESHEET  = css/custom.css css/doxygen-awesome.css
 # 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       = js/doxygen-awesome-darkmode-toggle.js
 
 # 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

diff --git a/docs/css/custom.css b/docs/css/custom.css
@@ -1,8 +1,13 @@
-#projectname, #projectbrief {
+#titlearea {
     color: var(--header-foreground) !important; /* Inherit color from parent */
     text-decoration: none; /* Remove underline */
 }
 
-#projectname:hover, #projectbrief:hover {
+#titlearea:hover {
     text-decoration: none; /* Ensure no underline on hover */
 }
+
+a[href="#details"],
+a[href$="source.html"] {
+    display: none; /* Hide links to details section and source files */
+}
diff --git a/docs/css/doxygen-awesome.css b/docs/css/doxygen-awesome.css
@@ -187,7 +187,7 @@ html {
     html:not(.light-mode) {
         color-scheme: dark;
 
-        --primary-color: #1982d2;
+        --primary-color: #59a0d6;
         --primary-dark-color: #86a9c4;
         --primary-light-color: #4779ac;
 
@@ -206,15 +206,15 @@ html {
         --code-background: #2a2c2f;
 
         --tablehead-background: #2a2c2f;
-    
+
         --blockquote-background: #222325;
         --blockquote-foreground: #7e8c92;
 
         --warning-color: #3b2e04;
         --warning-color-dark: #f1b602;
         --warning-color-darker: #ceb670;
         --note-color: #163750;
-        --note-color-dark: #1982D2;
+        --note-color-dark: #59a0d6;
         --note-color-darker: #dcf0fa;
         --todo-color: #2a2536;
         --todo-color-dark: #7661b3;
@@ -248,7 +248,7 @@ html {
 html.dark-mode {
     color-scheme: dark;
 
-    --primary-color: #1982d2;
+    --primary-color: #59a0d6;
     --primary-dark-color: #86a9c4;
     --primary-light-color: #4779ac;
 
@@ -275,7 +275,7 @@ html.dark-mode {
     --warning-color-dark: #f1b602;
     --warning-color-darker: #ceb670;
     --note-color: #163750;
-    --note-color-dark: #1982D2;
+    --note-color-dark: #59a0d6;
     --note-color-darker: #dcf0fa;
     --todo-color: #2a2536;
     --todo-color-dark: #7661b3;
@@ -896,7 +896,7 @@ div.header {
         flex-wrap: nowrap;
         align-items: flex-start;
     }
-    
+
     div.contents .textblock {
         min-width: 200px;
         flex-grow: 1;
@@ -988,21 +988,21 @@ html.dark-mode div.contents .dotgraph iframe
 h2.groupheader {
     border-bottom: 0px;
     color: var(--page-foreground-color);
-    box-shadow: 
-        100px 0 var(--page-background-color), 
+    box-shadow:
+        100px 0 var(--page-background-color),
         -100px 0 var(--page-background-color),
         100px 0.75px var(--separator-color),
         -100px 0.75px var(--separator-color),
-        500px 0 var(--page-background-color), 
+        500px 0 var(--page-background-color),
         -500px 0 var(--page-background-color),
         500px 0.75px var(--separator-color),
         -500px 0.75px var(--separator-color),
-        900px 0 var(--page-background-color), 
+        900px 0 var(--page-background-color),
         -900px 0 var(--page-background-color),
         900px 0.75px var(--separator-color),
         -900px 0.75px var(--separator-color),
         1400px 0 var(--page-background-color),
-        -1400px 0 var(--page-background-color), 
+        -1400px 0 var(--page-background-color),
         1400px 0.75px var(--separator-color),
         -1400px 0.75px var(--separator-color),
         1900px 0 var(--page-background-color),
@@ -1173,8 +1173,8 @@ div.toc li a.aboveActive {
 
     div.contents .toc.interactive > h3::before {
         content: "";
-        width: 0; 
-        height: 0; 
+        width: 0;
+        height: 0;
         border-left: 4px solid transparent;
         border-right: 4px solid transparent;
         border-top: 5px solid var(--primary-color);
@@ -1870,8 +1870,8 @@ table.memberdecls img[src="closed.png"],
 table.memberdecls img[src="open.png"],
 div.dynheader img[src="open.png"],
 div.dynheader img[src="closed.png"] {
-    width: 0; 
-    height: 0; 
+    width: 0;
+    height: 0;
     border-left: 4px solid transparent;
     border-right: 4px solid transparent;
     border-top: 5px solid var(--primary-color);
@@ -1889,7 +1889,7 @@ table.memberdecls img {
 table.memberdecls img[src="closed.png"],
 div.dynheader img[src="closed.png"] {
     transform: rotate(-90deg);
-    
+
 }
 
 .compoundTemplParams {
@@ -1932,7 +1932,7 @@ div.dynheader img[src="closed.png"] {
         margin-bottom: calc(0px - var(--page-font-size));
     }
 
-    table.memberdecls .memItemRight, 
+    table.memberdecls .memItemRight,
     table.memberdecls .mdescRight,
     table.memberdecls .memTemplItemRight {
         border-top: 0;
@@ -1997,7 +1997,7 @@ hr {
                 1400px 0 var(--separator-color),
                 -1400px 0 var(--separator-color),
                 1900px 0 var(--separator-color),
-                -1900px 0 var(--separator-color);       
+                -1900px 0 var(--separator-color);
 }
 
 .contents img, .contents .center, .contents center, .contents div.image object {
@@ -2120,8 +2120,8 @@ html.dark-mode .iconfopen, html.dark-mode .iconfclosed {
     background-color: transparent;
 }
 
-/* 
- Class Index Doxygen 1.8 
+/*
+ Class Index Doxygen 1.8
 */
 
 table.classindex {
@@ -2266,7 +2266,7 @@ div.contents .toc::-webkit-scrollbar-thumb,
     background-color: transparent;
     border: var(--webkit-scrollbar-padding) solid transparent;
     border-radius: calc(var(--webkit-scrollbar-padding) + var(--webkit-scrollbar-padding));
-    background-clip: padding-box;  
+    background-clip: padding-box;
 }
 
 #nav-tree:hover::-webkit-scrollbar-thumb,
@@ -2514,7 +2514,7 @@ h2:hover a.anchorlink, h1:hover a.anchorlink, h3:hover a.anchorlink, h4:hover a.
     cursor: pointer;
     box-shadow: 0 1px 0 0 var(--separator-color);
     position: relative;
-    
+
     -webkit-tap-highlight-color: transparent;
 }
 

diff --git a/docs/html/header.html b/docs/html/header.html
@@ -16,27 +16,27 @@
 $mathjax
 <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
 $extrastylesheet
+<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
+<script type="text/javascript">
+    DoxygenAwesomeDarkModeToggle.init()
+</script>
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 
 <!--BEGIN TITLEAREA-->
-<div id="titlearea">
+<a id="titlearea" href="$relpath^index.html">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
   <!--BEGIN PROJECT_LOGO-->
-  <td id="projectlogo">
-    <a href="/index.html">
-      <img alt="Logo" src="$relpath^$projectlogo"/>
-    </a>
-  </td>
+  <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
   <!--END PROJECT_LOGO-->
   <!--BEGIN PROJECT_NAME-->
   <td id="projectalign" style="padding-left: 0.5em;">
-   <a href="/index.html" id="projectname">$projectname
+   <div id="projectname">$projectname
    <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
-   </a>
+   </div>
   </td>
   <!--END PROJECT_NAME-->
   <!--BEGIN !PROJECT_NAME-->
@@ -54,6 +54,6 @@
  </tr>
  </tbody>
 </table>
-</div>
+</a>
 <!--END TITLEAREA-->
 <!-- end header part -->