Skip to content

Commit 392af06

Browse files
committed
Documentation updates
- Fix to .travis.yml to get latest git version - updated doxygen version 1.8.8 -> 1.8.10 - minor CSS tweaks to the page style and don't use webfonts anymore - added a useful filter script to convert python docstrings into doxygen-formatted comments on the fly
1 parent 16d3c54 commit 392af06

File tree

7 files changed

+1207
-180
lines changed

7 files changed

+1207
-180
lines changed

.travis.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
language: cpp
22
before_install:
3+
- sudo apt-add-repository -y ppa:git-core/ppa
4+
- sudo apt-get update -qq
5+
- sudo apt-get install git
36
- cd .. && mkdir -p src && mv $OLDPWD src/CombineHarvester
47
- export CMSSW_BASE=$PWD
58
- cd src/CombineHarvester
69
install:
7-
- export DOX=doxygen-1.8.8
10+
- export DOX=doxygen-1.8.10
811
- wget -O - http://ftp.stack.nl/pub/users/dimitri/${DOX}.linux.bin.tar.gz | tar xz -C ${TMPDIR-/tmp} ${DOX}/bin/doxygen
912
- sudo install -m 755 ${TMPDIR-/tmp}/${DOX}/bin/doxygen /usr/local/bin/doxygen
1013
script:

Doxyfile

Lines changed: 190 additions & 138 deletions
Large diffs are not rendered by default.

docs/customdoxygen.css

Lines changed: 175 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
11
body, table, div, p, dl {
2-
font: 400 14px/21px "Open Sans",sans-serif;
2+
-webkit-text-size-adjust: 100%;
3+
text-size-adjust: 100%;
4+
color: #333;
5+
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
6+
font-size: 16px;
7+
line-height: 1.6;
8+
word-wrap: break-word;
39
}
410

11+
/*Copied from markdown css*/
12+
a {
13+
background-color: transparent;
14+
}
15+
16+
/*Copied from markdown css*/
17+
a:active,
18+
a:hover {
19+
outline: 0;
20+
}
21+
22+
/*Copied from markdown css*/
23+
24+
strong {
25+
font-weight: bold;
26+
}
27+
28+
529
div#top {
630
width: 270px;
731
float: left;
@@ -17,15 +41,15 @@ div#titlearea td {
1741
}
1842

1943
#MSearchField {
20-
font: 9pt 'Open Sans', sans-serif;
44+
font: 9pt "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
2145
}
2246

2347
#MSearchClose {
2448
-webkit-box-shadow: none;
2549
}
2650

2751
.SelectItem {
28-
font: 8pt 'Open Sans', sans-serif;
52+
font: 8pt "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
2953
}
3054

3155
div#MSearchResultsWindow {
@@ -36,18 +60,23 @@ div#MSearchResultsWindow {
3660
border-bottom-right-radius: 7px;
3761
border-top-left-radius: 7px;
3862
border-bottom-left-radius: 7px;
63+
border: none;
64+
}
65+
66+
.SRPage .SREntry {
67+
font-size: 10pt;
3968
}
4069

4170
.SRSymbol {
42-
font-family: 'Open Sans', sans-serif !important;
71+
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
4372
}
4473

4574
a.SRScope {
46-
font-family: 'Open Sans', sans-serif !important;
75+
font-family:"Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol" !important;
4776
}
4877

4978
span.SRScope {
50-
font-family: 'Open Sans', sans-serif !important;
79+
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol" !important;
5180
}
5281

5382
#nav-tree {
@@ -58,7 +87,7 @@ span.SRScope {
5887
}
5988

6089
#nav-tree .label a {
61-
font: 12px 'Open Sans',Geneva,Helvetica,Arial,sans-serif;
90+
font: 12px "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
6291
color: rgb(164,164,164);
6392
}
6493

@@ -80,13 +109,33 @@ span.SRScope {
80109
}
81110

82111
code {
83-
font-family: Menlo;
84-
font-size: 12px;
85-
padding: 2px 4px;
86-
white-space: nowrap;
87-
background-color: rgba(102, 128, 153, 0.0745098);
112+
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
113+
padding: 0;
114+
padding-top: 0.2em;
115+
padding-bottom: 0.2em;
116+
margin: 0;
117+
font-size: 85%;
118+
background-color: rgba(0,0,0,0.04);
119+
border-radius: 3px;
120+
}
121+
122+
code:before,
123+
code:after {
124+
letter-spacing: -0.2em;
125+
content: "\00a0";
126+
}
127+
128+
pre>code {
129+
padding: 0;
130+
margin: 0;
131+
font-size: 100%;
132+
word-break: normal;
133+
white-space: pre;
134+
background: transparent;
135+
border: 0;
88136
}
89137

138+
90139
body {
91140
font: 400 16px/24px sans-serif;
92141
}
@@ -96,16 +145,63 @@ body {
96145
}
97146

98147
.title {
99-
font: 400 14px/28px "Open Sans",sans-serif;
100-
font-size: 150%;
148+
font: 400 14px/28px "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
149+
font-size: 1.9em;
101150
font-weight: bold;
102151
margin: 10px 2px;
103152
}
104153

105154
h1, h2, h3, h4, h5, h6 {
106-
font-family: 'Open Sans', sans-serif;
155+
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
156+
}
157+
158+
159+
h1,
160+
h2,
161+
h3,
162+
h4,
163+
h5,
164+
h6 {
165+
margin-top: 1em;
166+
margin-bottom: 16px;
167+
font-weight: bold;
168+
line-height: 1.4;
169+
}
170+
171+
h1 {
172+
padding-bottom: 0.3em;
173+
font-size: 1.75em;
174+
line-height: 1.2;
175+
border-bottom: 1px solid #eee;
176+
}
177+
178+
h2 {
179+
padding-bottom: 0.3em;
180+
font-size: 1.5em;
181+
line-height: 1.225;
182+
border-bottom: 1px solid #eee;
183+
}
184+
185+
h3 {
186+
font-size: 1.25em;
187+
line-height: 1.43;
188+
}
189+
190+
h4 {
191+
font-size: 1em;
192+
}
193+
194+
h5 {
195+
font-size: 1em;
196+
}
197+
198+
h6 {
199+
font-size: 1em;
200+
color: #777;
107201
}
108202

203+
204+
109205
h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
110206
text-shadow: 0 0 15px rgb(61, 87, 140);
111207
}
@@ -123,7 +219,7 @@ a.el {
123219
}
124220

125221

126-
pre.fragment {
222+
/*pre.fragment {
127223
border: 0px solid #C4CFE5;
128224
background-color: rgba(0,0,0,0.03);
129225
border-left: 0px;
@@ -137,6 +233,36 @@ pre.fragment {
137233
font-family: Menlo, monospace, fixed;
138234
font-size: 12px;
139235
}
236+
*/
237+
238+
pre.fragment {
239+
overflow: auto;
240+
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
241+
margin-top: 0px;
242+
margin-bottom: 0px;
243+
margin-left: 0px;
244+
margin-right: 0px;
245+
padding: 16px;
246+
font-size: 85%;
247+
line-height: 1.45;
248+
background-color: #f7f7f7;
249+
border-radius: 3px;
250+
word-wrap: normal;
251+
border: none;
252+
}
253+
254+
dd pre.fragment {
255+
overflow: auto;
256+
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
257+
margin: 4px 0px 4px 0px;
258+
padding: 6px;
259+
font-size: 85%;
260+
line-height: 1.45;
261+
background-color: rgba(0, 0, 0, 0.03);
262+
border-radius: 3px;
263+
word-wrap: normal;
264+
border: none;
265+
}
140266

141267
div.fragment {
142268
padding: 4px 13px;
@@ -148,10 +274,10 @@ div.fragment {
148274
}
149275

150276
div.line {
151-
font-family: "Menlo", monospace, fixed;
152-
font-size: 12px;
277+
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
278+
font-size: 85%;
153279
min-height: 12px;
154-
line-height: 100%;
280+
line-height: 1;
155281
text-wrap: unrestricted;
156282
white-space: -moz-pre-wrap; /* Moz */
157283
white-space: -pre-wrap; /* Opera 4-6 */
@@ -237,7 +363,7 @@ blockquote {
237363
box-shadow: none;
238364
border-top-right-radius: 0;
239365
border-top-left-radius: 0;
240-
-moz-box-shadow: none
366+
-moz-box-shadow: none;
241367
-moz-border-radius-topright: 0;
242368
-moz-border-radius-topleft: 0;
243369
-webkit-box-shadow: none;
@@ -260,26 +386,34 @@ blockquote {
260386

261387

262388
table.doxtable {
263-
margin: 20px;
264-
width: 85%;
265-
font-size: 14px;
389+
display: block;
390+
width: 100%;
391+
overflow: auto;
392+
word-break: normal;
393+
word-break: keep-all;
394+
}
395+
396+
table.doxtable th {
397+
font-weight: bold;
398+
background-color: rgba(0, 0, 0, 0);
399+
color: rgb(51, 51, 51);
266400
}
267401

402+
403+
table.doxtable th,
268404
table.doxtable td {
269-
border: 0px solid #FFFFFF;
270-
border-bottom: 1px solid #FFFFFF;
271-
border-top: 1px solid transparent;
272-
padding: 4px;
273-
color: #000000;
405+
font-size: 16px;
406+
padding: 6px 13px;
407+
border: 1px solid #ddd;
274408
}
275409

276-
table.doxtable th {
277-
background-color: #FFFFFF;
278-
border: 0px solid #000000;
279-
border-bottom: 2px solid #606860;
280-
font-size: 100%;
281-
padding: 4px;
282-
color: #000000;
410+
table.doxtable tr {
411+
background-color: #fff;
412+
border-top: 1px solid #ccc;
413+
}
414+
415+
table.doxtable tr:nth-child(2n) {
416+
background-color: #f8f8f8;
283417
}
284418

285419
table.fieldtable {
@@ -404,12 +538,13 @@ dl.section dd {
404538

405539
#projectname
406540
{
407-
font: 140% "Open Sans", Arial,sans-serif;
541+
font: 140% "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
542+
color: rgb(255, 255, 255);
408543
}
409544

410545
#projectbrief
411546
{
412-
font: 70% "Open Sans", Arial,sans-serif;
547+
font: 70% "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
413548
}
414549

415550

@@ -434,11 +569,11 @@ div.toc {
434569
}
435570

436571
div.toc li {
437-
font: 11px/1.2 "Open Sans",sans-serif;
572+
font: 11px/1.2 "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
438573
}
439574

440575
div.toc h3 {
441-
font: bold 11px/1.2 'Open Sans',FreeSans,sans-serif;
576+
font: bold 11px/1.2 "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
442577
}
443578

444579

@@ -455,5 +590,5 @@ div.toc li.level4 {
455590
}
456591

457592
#powerTip div {
458-
font: 12px/16px "Open Sans",sans-serif;
593+
font: 12px/16px "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
459594
}

docs/doxypypy/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)