Add Doxygen Awesome theme and logo
This commit is contained in:
David Madison
parent
f6bd614177
commit
2176990019
1
.gitignore
vendored
1
.gitignore
vendored
@ -3,3 +3,4 @@
|
||||
/.vscode
|
||||
/docs/html
|
||||
/docs/latex
|
||||
/docs/doxygen-awesome-css
|
||||
|
||||
@ -51,7 +51,7 @@ PROJECT_BRIEF =
|
||||
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
|
||||
# the logo to the output directory.
|
||||
|
||||
PROJECT_LOGO =
|
||||
PROJECT_LOGO = include/ws2812b_logo.svg
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||
# into which the generated documentation will be written. If a relative path is
|
||||
@ -1207,7 +1207,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 = include/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
|
||||
@ -1217,7 +1217,7 @@ HTML_HEADER =
|
||||
# that doxygen normally uses.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_FOOTER =
|
||||
HTML_FOOTER = include/footer.html
|
||||
|
||||
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
|
||||
# sheet that is used by each HTML page. It can be used to fine-tune the look of
|
||||
@ -1242,7 +1242,9 @@ HTML_STYLESHEET =
|
||||
# list). For an example see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_EXTRA_STYLESHEET =
|
||||
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
|
||||
doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
|
||||
doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.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
|
||||
@ -1252,7 +1254,7 @@ 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 = doxygen-awesome-css/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
|
||||
|
||||
18
docs/include/footer.html
Normal file
18
docs/include/footer.html
Normal file
@ -0,0 +1,18 @@
|
||||
<!-- HTML footer for doxygen 1.9.3-->
|
||||
<!-- start footer part -->
|
||||
<!--BEGIN GENERATE_TREEVIEW-->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby <a href="https://www.doxygen.org/index.html"><img class="footer" src="$relpath^doxygen.svg" width="104" height="31" alt="doxygen"/></a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
<!-- ... -->
|
||||
</body>
|
||||
</html>
|
||||
76
docs/include/header.html
Normal file
76
docs/include/header.html
Normal file
@ -0,0 +1,76 @@
|
||||
<!-- HTML header for doxygen 1.9.3-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN FULL_SIDEBAR-->
|
||||
<script type="text/javascript">var page_layout=1;</script>
|
||||
<!--END FULL_SIDEBAR-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
<link href="$relpath^ws2812b_logo.svg" type="image/svg+xml" rel="shortcut icon" />
|
||||
$extrastylesheet
|
||||
<script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
|
||||
<script type="text/javascript">DoxygenAwesomeDarkModeToggle.init()</script>
|
||||
</head>
|
||||
<body>
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN FULL_SIDEBAR-->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<!--END FULL_SIDEBAR-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--BEGIN TITLEAREA-->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<!--BEGIN PROJECT_LOGO-->
|
||||
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
|
||||
<!--END PROJECT_LOGO-->
|
||||
<!--BEGIN PROJECT_NAME-->
|
||||
<td id="projectalign">
|
||||
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber"> $projectnumber</span><!--END PROJECT_NUMBER-->
|
||||
</div>
|
||||
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
|
||||
</td>
|
||||
<!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_BRIEF-->
|
||||
<td>
|
||||
<div id="projectbrief">$projectbrief</div>
|
||||
</td>
|
||||
<!--END PROJECT_BRIEF-->
|
||||
<!--END !PROJECT_NAME-->
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<!--BEGIN !FULL_SIDEBAR-->
|
||||
<td>$searchbox</td>
|
||||
<!--END !FULL_SIDEBAR-->
|
||||
<!--END SEARCHENGINE-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
</tr>
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<!--BEGIN FULL_SIDEBAR-->
|
||||
<tr><td colspan="2">$searchbox</td></tr>
|
||||
<!--END FULL_SIDEBAR-->
|
||||
<!--END SEARCHENGINE-->
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
||||
77
docs/include/ws2812b_logo.svg
Normal file
77
docs/include/ws2812b_logo.svg
Normal file
@ -0,0 +1,77 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 16.0.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
width="40px" height="36.365px" viewBox="255 231.817 40 36.365" enable-background="new 255 231.817 40 36.365"
|
||||
xml:space="preserve">
|
||||
<style>
|
||||
path#Light {
|
||||
display: none;
|
||||
animation: rainbow 10000ms infinite linear;
|
||||
filter: blur(3px);
|
||||
opacity: 50%;
|
||||
height: 150%;
|
||||
}
|
||||
|
||||
@keyframes rainbow {
|
||||
0.000% { fill: hsl( 0,100%,50%); }
|
||||
3.125% { fill: hsl( 11,100%,50%); }
|
||||
6.250% { fill: hsl( 22,100%,50%); }
|
||||
9.375% { fill: hsl( 33,100%,50%); }
|
||||
12.500% { fill: hsl( 45,100%,50%); }
|
||||
15.625% { fill: hsl( 56,100%,50%); }
|
||||
18.750% { fill: hsl( 67,100%,50%); }
|
||||
21.875% { fill: hsl( 78,100%,50%); }
|
||||
25.000% { fill: hsl( 90,100%,50%); }
|
||||
28.125% { fill: hsl(101,100%,50%); }
|
||||
31.250% { fill: hsl(112,100%,50%); }
|
||||
34.375% { fill: hsl(123,100%,50%); }
|
||||
37.500% { fill: hsl(135,100%,50%); }
|
||||
40.625% { fill: hsl(146,100%,50%); }
|
||||
43.750% { fill: hsl(157,100%,50%); }
|
||||
46.875% { fill: hsl(168,100%,50%); }
|
||||
50.000% { fill: hsl(180,100%,50%); }
|
||||
53.125% { fill: hsl(191,100%,50%); }
|
||||
56.250% { fill: hsl(202,100%,50%); }
|
||||
59.375% { fill: hsl(213,100%,50%); }
|
||||
62.500% { fill: hsl(225,100%,50%); }
|
||||
65.625% { fill: hsl(236,100%,50%); }
|
||||
68.750% { fill: hsl(247,100%,50%); }
|
||||
71.875% { fill: hsl(258,100%,50%); }
|
||||
75.000% { fill: hsl(270,100%,50%); }
|
||||
78.125% { fill: hsl(281,100%,50%); }
|
||||
81.250% { fill: hsl(292,100%,50%); }
|
||||
84.375% { fill: hsl(303,100%,50%); }
|
||||
87.500% { fill: hsl(315,100%,50%); }
|
||||
90.625% { fill: hsl(326,100%,50%); }
|
||||
93.750% { fill: hsl(337,100%,50%); }
|
||||
96.875% { fill: hsl(348,100%,50%); }
|
||||
100.000% { fill: hsl(360,100%,50%); }
|
||||
}
|
||||
</style>
|
||||
<g id="WS2812B_LED">
|
||||
<g id="Contacts">
|
||||
<rect x="255" y="235.091" fill="#CCCCCC" width="1.819" height="8.873"/>
|
||||
<rect x="293.183" y="235.091" fill="#CCCCCC" width="1.817" height="8.873"/>
|
||||
<rect x="255" y="256.109" fill="#CCCCCC" width="1.819" height="8.872"/>
|
||||
<rect x="293.183" y="256.109" fill="#CCCCCC" width="1.817" height="8.872"/>
|
||||
</g>
|
||||
<rect id="Body" x="256.819" y="231.817" fill="#FAFAFA" width="36.363" height="36.365"/>
|
||||
<path id="Lens" fill="#BFBFBF" d="M289.914,250.003c0,8.234-6.675,14.91-14.911,14.91c-8.234,0-14.91-6.676-14.91-14.91
|
||||
c0-8.236,6.676-14.912,14.91-14.912C283.239,235.091,289.914,241.767,289.914,250.003z"/>
|
||||
<path id="Substrate" fill="#FFFFFF" d="M287.211,250.003c0-6.742-5.466-12.209-12.208-12.209c-4.553,0-8.523,2.492-10.623,6.188
|
||||
c-1.01,1.776-1.586,3.832-1.586,6.021c0,6.742,5.467,12.207,12.209,12.207S287.211,256.747,287.211,250.003z"/>
|
||||
<g id="Fingers">
|
||||
<path fill="#DCDCDC" d="M283.655,245.782h-5.164c-1,0-1.818,0.818-1.818,1.818v14.533c3.73-0.509,6.926-2.697,8.801-5.779v-8.754
|
||||
C285.474,246.601,284.655,245.782,283.655,245.782z"/>
|
||||
<path fill="#DCDCDC" d="M276.673,237.87v4.316c0,1,0.818,1.777,1.818,1.777h7.165C283.813,240.718,280.528,238.397,276.673,237.87
|
||||
z"/>
|
||||
<path fill="#DCDCDC" d="M275,238.509v-0.751c-4.565,0.001-8.547,2.501-10.651,6.206l0,0h0.111h0.066h0.365
|
||||
c1,0,1.818,0.816,1.818,1.816v4.074c0,1,0.816,1.816,1.816,1.816h4.654c1,0,1.819-0.816,1.819-1.816l0.001-11.348L275,238.509z"/>
|
||||
<path fill="#DCDCDC" d="M273.181,253.347h-4.727c-1,0-1.818,0.555-1.818,1.234c0,0.682-0.816,1.236-1.816,1.236h-0.391h-0.094
|
||||
h-0.025h-0.084c2.068,3.828,6.118,6.43,10.775,6.43v-7.083C275,254.163,274.181,253.347,273.181,253.347z"/>
|
||||
</g>
|
||||
<path id="Light" display="none" fill="#FF0000" d="M289.914,250.003c0,8.234-6.675,14.91-14.911,14.91
|
||||
c-8.234,0-14.91-6.676-14.91-14.91c0-8.236,6.676-14.912,14.91-14.912C283.239,235.091,289.914,241.767,289.914,250.003z"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.8 KiB |
Loading…
Reference in New Issue
Block a user