Skip to content

Commit e0ed581

Browse files
schornakjschornakj
committed
add a CI step to generate project doxygen documentation
1 parent 2922b91 commit e0ed581

File tree

4 files changed

+2670
-0
lines changed

4 files changed

+2670
-0
lines changed

‎.github/workflows/api_docs.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: DeployDocumentation
2+
3+
on:
4+
push:
5+
branches:
6+
- devel
7+
8+
jobs:
9+
deploy_documentation:
10+
runs-on: ubuntu-18.04
11+
steps:
12+
- uses: actions/checkout@v1
13+
14+
- name: Build Doxygen Documentation
15+
uses: mattnotmitt/doxygen-action@v1
16+
with:
17+
doxyfile-path: 'doxygen.config'
18+
19+
- name: Deploy Documentation
20+
uses: peaceiris/actions-gh-pages@v3
21+
with:
22+
github_token: ${{ secrets.GITHUB_TOKEN }}
23+
publish_dir: ./docs
24+
keep_files: true

‎docs/custom.css

+340
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,340 @@
1+
div.fragment, pre.fragment {
2+
margin: 0;
3+
padding: 4px;
4+
}
5+
6+
/*********************************************/
7+
/** Main content **/
8+
/*********************************************/
9+
.contents {
10+
margin: 10px auto !important;
11+
padding: 0 10px;
12+
max-width: 1200px;
13+
}
14+
15+
/*********************************************/
16+
/** Inline code **/
17+
/*********************************************/
18+
p code,
19+
li code,
20+
td code,
21+
dd code {
22+
display: inline;
23+
padding: 0px 6px;
24+
-webkit-border-radius: 4px;
25+
-moz-border-radius: 4px;
26+
border-radius: 4px;
27+
28+
background-color: #CCCCCC;
29+
border: 1px solid #333333;
30+
31+
color: #333333;
32+
}
33+
34+
/*********************************************/
35+
/** Table of Contents (ToC) **/
36+
/*********************************************/
37+
div.toc {
38+
margin: 0 !important;
39+
border-radius: 4px !important;
40+
}
41+
42+
div.toc h3 {
43+
font-size: 150%;
44+
color: inherit;
45+
}
46+
47+
/*********************************************/
48+
/** Content table **/
49+
/*********************************************/
50+
.contents table.doxtable {
51+
margin: 0 auto;
52+
}
53+
54+
/*********************************************/
55+
/** Field table **/
56+
/*********************************************/
57+
.fieldtable {
58+
box-shadow: none !important;
59+
-webkit-box-shadow: none;
60+
-moz-box-shadow: none;
61+
}
62+
63+
/*********************************************/
64+
/** Memitem and memtitle **/
65+
/*********************************************/
66+
.memitem,
67+
.memproto,
68+
.memdoc {
69+
box-shadow: none;
70+
-webkit-box-shadow: none;
71+
-moz-box-shadow: none;
72+
background-image: none;
73+
}
74+
75+
/*********************************************/
76+
/** TOP navigation **/
77+
/*********************************************/
78+
.tablist a:hover,
79+
.tablist li.current a {
80+
text-shadow: none;
81+
-moz-text-shadow: none;
82+
-webkit-text-shadow: none;
83+
}
84+
85+
/*********************************************/
86+
/** H1 in textblocks **/
87+
/*********************************************/
88+
.textblock h1 {
89+
border-bottom: 1px solid #32363d;
90+
border-left: 3px solid #32363d;
91+
margin: 40px 0px 10px 0px;
92+
padding-bottom: 10px;
93+
padding-top: 10px;
94+
padding-left: 5px;
95+
}
96+
97+
.textblock h1:first-child {
98+
margin-top: 10px;
99+
}
100+
101+
/*********************************************/
102+
/** Note, warning **/
103+
/*********************************************/
104+
dl.note,
105+
dl.warning,
106+
dl.todo,
107+
dl.deprecated,
108+
dl.reflist {
109+
border: 0;
110+
padding: 0px;
111+
margin: 4px 0px 4px 0px;
112+
border-radius: 4px;
113+
}
114+
115+
dl.note dt,
116+
dl.warning dt,
117+
dl.todo dt,
118+
dl.deprecated dt,
119+
dl.reflist dt {
120+
margin: 0;
121+
font-size: 14px;
122+
padding: 2px 4px;
123+
124+
border: none;
125+
border-top-left-radius: 0px;
126+
border-top-right-radius:0px;
127+
128+
font-weight: bold;
129+
text-transform: uppercase;
130+
color: #FFFFFF !important;
131+
132+
box-shadow: none;
133+
-webkit-box-shadow: none;
134+
-moz-box-shadow: none;
135+
text-shadow: none;
136+
}
137+
138+
dl.note dd,
139+
dl.warning dd,
140+
dl.todo dd,
141+
dl.deprecated dd,
142+
dl.reflist dd {
143+
margin: 0;
144+
padding: 4px;
145+
background: none;
146+
147+
color: #222222;
148+
149+
border: 1px solid;
150+
border-bottom-left-radius: 0px;
151+
border-bottom-right-radius: 0px;
152+
border-top: none;
153+
154+
box-shadow: none;
155+
-webkit-box-shadow: none;
156+
-moz-box-shadow: none;
157+
text-shadow: none;
158+
}
159+
160+
dl.reflist dd {
161+
margin-bottom: 15px;
162+
}
163+
164+
/* Background colors */
165+
dl.note {}
166+
dl.warning {}
167+
dl.todo {}
168+
dl.deprecated {}
169+
dl.reflist {}
170+
171+
/* Header */
172+
dl.note dt {
173+
background-color: #cbc693;
174+
}
175+
176+
dl.warning dt {
177+
background-color: #bf5f82;
178+
}
179+
180+
dl.todo dt {
181+
background-color: #82b3c9;
182+
}
183+
184+
dl.deprecated dt {
185+
background-color: #af8eb5;
186+
}
187+
188+
dl.reflist dt {
189+
background-color: #cbae82;
190+
}
191+
192+
/* Content */
193+
dl.note dd {
194+
background-color: #fff9c4;
195+
border-color: #cbc693;
196+
}
197+
198+
dl.warning dd {
199+
background-color: #f48fb1;
200+
border-color: #bf5f82;
201+
}
202+
203+
dl.todo dd {
204+
background-color: #b3e5fc;
205+
border-color: #82b3c9;
206+
}
207+
208+
dl.deprecated dd {
209+
background-color: #e1bee7;
210+
border-color: #af8eb5;
211+
}
212+
213+
dl.reflist dd {
214+
background-color: #ffe0b2;
215+
border-color: #cbae82;
216+
}
217+
218+
/*********************************************/
219+
/** Reference list **/
220+
/**Similar to warning/note/todo/... messages**/
221+
/*********************************************/
222+
dl.reflist {
223+
224+
}
225+
226+
/*********************************************/
227+
/** Note, warning **/
228+
/*********************************************/
229+
#docs_list {
230+
padding: 0 10px;
231+
}
232+
233+
#docs_list ul {
234+
margin: 0;
235+
padding: 0;
236+
list-style: none;
237+
}
238+
239+
#docs_list ul li {
240+
display: inline-block;
241+
border-right: 1px solid #BFBFBF;
242+
}
243+
244+
#docs_list ul li:last-child {
245+
border-right: none;
246+
}
247+
248+
#docs_list ul li a {
249+
display: block;
250+
padding: 8px 13px;
251+
font-weight: bold;
252+
font-size: 15px;
253+
}
254+
255+
#docs_list ul li a:hover,
256+
#docs_list ul li a.docs_current {
257+
text-decoration: underline;
258+
}
259+
260+
/*********************************************/
261+
/** Resizable UI **/
262+
/*********************************************/
263+
.ui-resizable-e {
264+
width: 3px;
265+
}
266+
267+
/*********************************************/
268+
/** Download url **/
269+
/*********************************************/
270+
.download_url {
271+
font-weight: bold;
272+
font-size: 150%;
273+
line-height: 150%;
274+
}
275+
276+
/*********************************************/
277+
/** Syntax folor **/
278+
/*********************************************/
279+
div.line a {
280+
text-decoration: underline;
281+
}
282+
283+
span.lineno a {
284+
text-decoration: none;
285+
}
286+
287+
/*********************************************/
288+
/** Modules/Directory table **/
289+
/*********************************************/
290+
.directory .arrow {
291+
height: initial;
292+
}
293+
294+
.directory td.entry {
295+
padding: 3px 6px;
296+
}
297+
298+
/*********************************************/
299+
/** Mem items **/
300+
/*********************************************/
301+
.memproto table td {
302+
font-family: monospace, fixed !important;
303+
}
304+
305+
td.memItemLeft, td.memItemRight {
306+
font-family: monospace, fixed;
307+
}
308+
309+
.paramname, .paramname em {
310+
font-style: italic;
311+
}
312+
313+
.memdoc {
314+
text-shadow: none;
315+
}
316+
317+
.memItem {
318+
font-family: monospace, fixed;
319+
}
320+
321+
.memItem table {
322+
font-family: inherit;
323+
}
324+
325+
/*********************************************/
326+
/** Footer **/
327+
/*********************************************/
328+
img.footer {
329+
height: 22px;
330+
}
331+
332+
/*********************************************/
333+
/** Custom scrollbar **/
334+
/*********************************************/
335+
336+
/*********************************************/
337+
/** Custom scrollbar **/
338+
/*********************************************/
339+
340+

‎docs/index.html

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html><head><meta http-equiv=Refresh content="0;url=doxygen/html/index.html"></head></html>

0 commit comments

Comments
 (0)