Skip to content

Commit 2a8c863

Browse files
anonriganonrig
committed
docs: improve dark mode support
1 parent ebb3480 commit 2a8c863

File tree

3 files changed

+94
-5
lines changed

3 files changed

+94
-5
lines changed

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ __pycache__
88
cmake-build-debug
99

1010
.cache
11-
docs
11+
docs/html
12+
docs/theme
1213

1314
# Generated using only the Github workflow
1415
benchmark_result.json

‎docs/doxygen/header.html‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!-- HTML header for doxygen 1.9.6-->
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
7+
<meta name="generator" content="Doxygen $doxygenversion"/>
8+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
9+
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
10+
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
11+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
12+
<!--BEGIN DISABLE_INDEX-->
13+
<!--BEGIN FULL_SIDEBAR-->
14+
<script type="text/javascript">var page_layout=1;</script>
15+
<!--END FULL_SIDEBAR-->
16+
<!--END DISABLE_INDEX-->
17+
<script type="text/javascript" src="$relpath^jquery.js"></script>
18+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
19+
<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
20+
<script type="text/javascript" src="$relpath^doxygen-awesome-fragment-copy-button.js"></script>
21+
<script type="text/javascript" src="$relpath^doxygen-awesome-paragraph-link.js"></script>
22+
<script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script>
23+
<script type="text/javascript">
24+
DoxygenAwesomeDarkModeToggle.init()
25+
DoxygenAwesomeFragmentCopyButton.init()
26+
DoxygenAwesomeParagraphLink.init()
27+
DoxygenAwesomeInteractiveToc.init()
28+
</script>
29+
$treeview
30+
$search
31+
$mathjax
32+
$darkmode
33+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
34+
$extrastylesheet
35+
</head>
36+
<body>
37+
<!--BEGIN DISABLE_INDEX-->
38+
<!--BEGIN FULL_SIDEBAR-->
39+
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
40+
<!--END FULL_SIDEBAR-->
41+
<!--END DISABLE_INDEX-->
42+
43+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
44+
45+
<!--BEGIN TITLEAREA-->
46+
<div id="titlearea">
47+
<table cellspacing="0" cellpadding="0">
48+
<tbody>
49+
<tr id="projectrow">
50+
<!--BEGIN PROJECT_LOGO-->
51+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
52+
<!--END PROJECT_LOGO-->
53+
<!--BEGIN PROJECT_NAME-->
54+
<td id="projectalign">
55+
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
56+
</div>
57+
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
58+
</td>
59+
<!--END PROJECT_NAME-->
60+
<!--BEGIN !PROJECT_NAME-->
61+
<!--BEGIN PROJECT_BRIEF-->
62+
<td>
63+
<div id="projectbrief">$projectbrief</div>
64+
</td>
65+
<!--END PROJECT_BRIEF-->
66+
<!--END !PROJECT_NAME-->
67+
<!--BEGIN DISABLE_INDEX-->
68+
<!--BEGIN SEARCHENGINE-->
69+
<!--BEGIN !FULL_SIDEBAR-->
70+
<td>$searchbox</td>
71+
<!--END !FULL_SIDEBAR-->
72+
<!--END SEARCHENGINE-->
73+
<!--END DISABLE_INDEX-->
74+
</tr>
75+
<!--BEGIN SEARCHENGINE-->
76+
<!--BEGIN FULL_SIDEBAR-->
77+
<tr><td colspan="2">$searchbox</td></tr>
78+
<!--END FULL_SIDEBAR-->
79+
<!--END SEARCHENGINE-->
80+
</tbody>
81+
</table>
82+
</div>
83+
<!--END TITLEAREA-->
84+
<!-- end header part -->

‎doxygen‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,7 +1017,7 @@ RECURSIVE = YES
10171017
# Note that relative paths are relative to the directory from which doxygen is
10181018
# run.
10191019

1020-
EXCLUDE = benchmarks, tests, Testing, tools, build, docs, include/ada/expected.h, singleheader, include/ada/log.h
1020+
EXCLUDE = benchmarks, tests, Testing, tools, build, docs/html, docs/theme, include/ada/expected.h, singleheader, include/ada/log.h
10211021

10221022
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
10231023
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -1290,7 +1290,7 @@ HTML_FILE_EXTENSION = .html
12901290
# of the possible markers and block names see the documentation.
12911291
# This tag requires that the tag GENERATE_HTML is set to YES.
12921292

1293-
HTML_HEADER =
1293+
HTML_HEADER = docs/doxygen/header.html
12941294

12951295
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
12961296
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1341,7 +1341,11 @@ HTML_EXTRA_STYLESHEET = docs/theme/doxygen-awesome.css \
13411341
# files will be copied as-is; there are no commands or markers available.
13421342
# This tag requires that the tag GENERATE_HTML is set to YES.
13431343

1344-
HTML_EXTRA_FILES = docs/theme/doxygen-awesome-darkmode-toggle.js
1344+
HTML_EXTRA_FILES = docs/theme/doxygen-awesome-darkmode-toggle.js \
1345+
docs/theme/doxygen-awesome-sidebar-only-darkmode-toggle.css \
1346+
docs/theme/doxygen-awesome-fragment-copy-button.js \
1347+
docs/theme/doxygen-awesome-paragraph-link.js \
1348+
docs/theme/doxygen-awesome-interactive-toc.js
13451349

13461350
# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
13471351
# should be rendered with a dark or light theme.
@@ -1894,7 +1898,7 @@ EXTRA_SEARCH_MAPPINGS =
18941898
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
18951899
# The default value is: YES.
18961900

1897-
GENERATE_LATEX = YES
1901+
GENERATE_LATEX = NO
18981902

18991903
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
19001904
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

0 commit comments

Comments
 (0)