Skip to content

Commit 18e7810

Browse files
gigapodgigapod
committed
added base entries for doxygen support
1 parent 420c153 commit 18e7810

File tree

7 files changed

+2969
-1
lines changed

7 files changed

+2969
-1
lines changed

‎.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "docs/doxygen/doxygen-awesome-css"]
2+
path = docs/doxygen/doxygen-awesome-css
3+
url = https://github.com/jothepro/doxygen-awesome-css.git

‎docs/doxygen/doxygen-awesome-css

Submodule doxygen-awesome-css added at 5b27b3a

‎docs/doxygen/doxygen-config

Lines changed: 2818 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/doxygen/doxygen-custom/custom.css

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:root {
2+
--side-nav-fixed-width: 300px;
3+
}
4+
5+
.github-corner svg {
6+
fill: var(--primary-light-color);
7+
color: var(--page-background-color);
8+
width: 72px;
9+
height: 72px;
10+
}
11+
12+
#projectnumber {
13+
margin-right: 22px;
14+
}
15+
16+
@media screen and (max-width: 767px) {
17+
.github-corner svg {
18+
width: 55px;
19+
height: 55px;
20+
}
21+
}

‎docs/doxygen/doxygen-custom/header.html

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
<!-- HTML header for doxygen 1.9.1-->
2+
<!DOCTYPE html
3+
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
8+
<meta http-equiv="X-UA-Compatible" content="IE=9" />
9+
<meta name="generator" content="Doxygen $doxygenversion" />
10+
<meta name="viewport" content="width=device-width, initial-scale=1" />
11+
12+
<!-- BEGIN opengraph metadata -->
13+
<meta property="og:title" content="SparkFun Optical Tracking Odometry Sensor Arduino Library" />
14+
<meta property="og:description"
15+
content="An Arduino Library implementation for the SparkFun Optical Tracking Odometry Sensor." />
16+
<meta property="og:url" content="https://docs.sparkfun.com/SparkFun_Qwiic_OTOS_Arduino_Library/" />
17+
<!-- END opengraph metadata -->
18+
19+
<!-- BEGIN twitter metadata -->
20+
<meta name="twitter:title" content="SparkFun Optical Tracking Odometry Sensor Arduino Library" />
21+
<meta name="twitter:description"
22+
content="An Arduino Library implementation for the SparkFun Optical Tracking Odometry Sensor." />
23+
<!-- END twitter metadata -->
24+
25+
<!--BEGIN PROJECT_NAME-->
26+
<title>$projectname: $title</title><!--END PROJECT_NAME-->
27+
<!--BEGIN !PROJECT_NAME-->
28+
<title>$title</title><!--END !PROJECT_NAME-->
29+
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css" />
30+
<link rel="icon" type="image/png" href="sfe_flame.png">
31+
<script type="text/javascript" src="$relpath^jquery.js"></script>
32+
<script type="text/javascript" src="$relpath^dynsections.js"></script>
33+
$treeview
34+
$search
35+
$mathjax
36+
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
37+
$extrastylesheet
38+
</head>
39+
40+
<body>
41+
42+
<!-- https://tholman.com/github-corners/ -->
43+
<a href="https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library/" class="github-corner"
44+
title="View source on GitHub">
45+
<svg viewBox="0 0 250 250" style="position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true">
46+
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
47+
<path
48+
d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
49+
fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
50+
<path
51+
d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
52+
fill="currentColor" class="octo-body"></path>
53+
</svg></a>
54+
<style>
55+
.github-corner:hover .octo-arm {
56+
animation: octocat-wave 560ms ease-in-out
57+
}
58+
59+
@keyframes octocat-wave {
60+
61+
0%,
62+
100% {
63+
transform: rotate(0)
64+
}
65+
66+
20%,
67+
60% {
68+
transform: rotate(-25deg)
69+
}
70+
71+
40%,
72+
80% {
73+
transform: rotate(10deg)
74+
}
75+
}
76+
77+
@media (max-width:500px) {
78+
.github-corner:hover .octo-arm {
79+
animation: none
80+
}
81+
82+
.github-corner .octo-arm {
83+
animation: octocat-wave 560ms ease-in-out
84+
}
85+
}
86+
</style>
87+
88+
89+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
90+
91+
<!--BEGIN TITLEAREA-->
92+
<div id="titlearea">
93+
<table cellspacing="0" cellpadding="0">
94+
<tbody>
95+
<tr style="height: 56px;">
96+
<!--BEGIN PROJECT_LOGO-->
97+
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo" /></td>
98+
<!--END PROJECT_LOGO-->
99+
<!--BEGIN PROJECT_NAME-->
100+
<td id="projectalign" style="padding-left: 0.5em;">
101+
<div id="projectname">$projectname
102+
<!--BEGIN PROJECT_NUMBER-->&#160;<span
103+
id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
104+
</div>
105+
<!--BEGIN PROJECT_BRIEF-->
106+
<div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
107+
</td>
108+
<!--END PROJECT_NAME-->
109+
<!--BEGIN !PROJECT_NAME-->
110+
<!--BEGIN PROJECT_BRIEF-->
111+
<td style="padding-left: 0.5em;">
112+
<div id="projectbrief">$projectbrief</div>
113+
</td>
114+
<!--END PROJECT_BRIEF-->
115+
<!--END !PROJECT_NAME-->
116+
<!--BEGIN DISABLE_INDEX-->
117+
<!--BEGIN SEARCHENGINE-->
118+
<td>$searchbox</td>
119+
<!--END SEARCHENGINE-->
120+
<!--END DISABLE_INDEX-->
121+
</tr>
122+
</tbody>
123+
</table>
124+
</div>
125+
<!--END TITLEAREA-->
126+
<!-- end header part -->

‎docs/images/sfe_flame.png

3.74 KB
Loading

‎documents/add_documents_here.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)