Skip to content

Commit f858fe8

Browse files
committed
docu: using Twitter Bootstrap for generated HTML pages
Through this introducing a few colors to the documentation to aid readability. Without additional Javascript as TWBS requires jQuery 1.9 and Doxygen comes with 1.7.
1 parent ca654cf commit f858fe8

File tree

6 files changed

+1841
-12
lines changed

6 files changed

+1841
-12
lines changed

Doxyfile

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "PFASST"
35+
PROJECT_NAME = "PFASST++"
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
@@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = doc/build
6868
# performance problems for the file system.
6969
# The default value is: NO.
7070

71-
CREATE_SUBDIRS = NO
71+
CREATE_SUBDIRS = YES
7272

7373
# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
7474
# characters to appear in the names of generated files. If set to NO, non-ASCII
@@ -228,7 +228,8 @@ TAB_SIZE = 4
228228
# "Side Effects:". You can put \n's in the value part of an alias to insert
229229
# newlines.
230230

231-
ALIASES =
231+
ALIASES += internals="\internal \parblock"
232+
ALIASES += endinternals="\endparblock \endinternal"
232233

233234
# This tag can be used to specify a number of word-keyword mappings (TCL only).
234235
# A mapping has the form "name=value". For example adding "class=itcl::class"
@@ -1023,7 +1024,7 @@ ALPHABETICAL_INDEX = YES
10231024
# Minimum value: 1, maximum value: 20, default value: 5.
10241025
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
10251026

1026-
COLS_IN_ALPHA_INDEX = 5
1027+
COLS_IN_ALPHA_INDEX = 2
10271028

10281029
# In case all classes in a project start with a common prefix, all classes will
10291030
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
@@ -1075,7 +1076,7 @@ HTML_FILE_EXTENSION = .html
10751076
# of the possible markers and block names see the documentation.
10761077
# This tag requires that the tag GENERATE_HTML is set to YES.
10771078

1078-
HTML_HEADER =
1079+
HTML_HEADER = doc/source/customized/header.html
10791080

10801081
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
10811082
# generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1085,7 +1086,7 @@ HTML_HEADER =
10851086
# that doxygen normally uses.
10861087
# This tag requires that the tag GENERATE_HTML is set to YES.
10871088

1088-
HTML_FOOTER =
1089+
HTML_FOOTER = doc/source/customized/footer.html
10891090

10901091
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
10911092
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1097,7 +1098,7 @@ HTML_FOOTER =
10971098
# obsolete.
10981099
# This tag requires that the tag GENERATE_HTML is set to YES.
10991100

1100-
HTML_STYLESHEET =
1101+
HTML_STYLESHEET = doc/source/customized/default.css
11011102

11021103
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
11031104
# cascading style sheets that are included after the standard style sheets
@@ -1110,7 +1111,7 @@ HTML_STYLESHEET =
11101111
# list). For an example see the documentation.
11111112
# This tag requires that the tag GENERATE_HTML is set to YES.
11121113

1113-
HTML_EXTRA_STYLESHEET =
1114+
HTML_EXTRA_STYLESHEET = doc/source/customized/custom.css
11141115

11151116
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
11161117
# other source files which should be copied to the HTML output directory. Note
@@ -1120,7 +1121,7 @@ HTML_EXTRA_STYLESHEET =
11201121
# files will be copied as-is; there are no commands or markers available.
11211122
# This tag requires that the tag GENERATE_HTML is set to YES.
11221123

1123-
HTML_EXTRA_FILES =
1124+
HTML_EXTRA_FILES = doc/source/customized/custom_tweaks.js
11241125

11251126
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
11261127
# will adjust the colors in the style sheet and background images according to
@@ -1158,7 +1159,7 @@ HTML_COLORSTYLE_GAMMA = 80
11581159
# The default value is: YES.
11591160
# This tag requires that the tag GENERATE_HTML is set to YES.
11601161

1161-
HTML_TIMESTAMP = NO
1162+
HTML_TIMESTAMP = YES
11621163

11631164
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
11641165
# documentation will contain sections that can be hidden and shown after the
@@ -1378,7 +1379,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
13781379
# The default value is: NO.
13791380
# This tag requires that the tag GENERATE_HTML is set to YES.
13801381

1381-
DISABLE_INDEX = NO
1382+
DISABLE_INDEX = YES
13821383

13831384
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
13841385
# structure should be generated to display hierarchical information. If the tag
@@ -1473,7 +1474,7 @@ MATHJAX_FORMAT = HTML-CSS
14731474
# The default value is: http://cdn.mathjax.org/mathjax/latest.
14741475
# This tag requires that the tag USE_MATHJAX is set to YES.
14751476

1476-
MATHJAX_RELPATH = https://pint.fz-juelich.de/mathjax/latest
1477+
MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest
14771478

14781479
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
14791480
# extension names that should be enabled during MathJax rendering. For example

doc/source/customized/custom.css

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
#nav-tree img {
2+
box-sizing: content-box;
3+
}
4+
5+
ul.meta-info-block {
6+
font-size: 0.8em;
7+
color: gray;
8+
padding: 0;
9+
}
10+
11+
ul.meta-info-block > li {
12+
display: block;
13+
margin: -3px;
14+
}
15+
16+
p.lead {
17+
font-size: 1.15em;
18+
font-style: italic;
19+
}
20+
21+
code {
22+
border: 1px solid #C4CFE5;
23+
background-color: #FBFCFD;
24+
padding: 1px;
25+
}
26+
27+
.memdoc .panel {
28+
margin-bottom: 5px !important;
29+
}
30+
31+
.memdoc .panel .panel-heading,
32+
.memdoc .panel .panel-body,
33+
.memdoc .panel .list-group-item,
34+
.reflist .panel .panel-heading,
35+
.reflist .panel .panel-body,
36+
.textblock .panel .panel-heading,
37+
.textblock .panel .panel-body {
38+
padding: 5px;
39+
padding-left: 10px;
40+
}
41+
.memdoc .section.see {
42+
font-size: 90%;
43+
}
44+
45+
.panel-footer ul {
46+
margin-top: 0;
47+
margin-bottom: 0;
48+
}
49+
50+
/* width of all text blocks */
51+
.textblock,
52+
.memdoc.panel-body > *,
53+
.memdoc > .panel,
54+
.memdoc > .panel > .panel-body > *,
55+
.memitem > .panel,
56+
.memitem > .panel > .panel-body > * {
57+
width: 750px;
58+
}
59+
60+
61+
table.directory .badge {
62+
margin-right: 3px;
63+
}
64+
65+
dl.citelist > dd > p {
66+
padding-left: 50px;
67+
}

0 commit comments

Comments
 (0)