Skip to content

Commit

Permalink
Updated Doxygen theme to resemble GitHub Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Pieter committed Dec 10, 2018
1 parent bfa8131 commit 9410d63
Show file tree
Hide file tree
Showing 7 changed files with 584 additions and 11 deletions.
2 changes: 1 addition & 1 deletion boards/avr/piconomix_scorpion_board/README.dox
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

A Microchip ATmega328P development board.

![Piconomix ATmega328P Scorpion Board](piconomix_scorpion_board/piconomix_scorpion_board.jpg)
@image html piconomix_scorpion_board/piconomix_scorpion_board.jpg "Piconomix ATmega328P Scorpion Board" width=650px

There is:

Expand Down
21 changes: 11 additions & 10 deletions doc/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -238,10 +238,10 @@ TAB_SIZE = 4
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.

ALIASES = "tip_s=<span class=\"tip\"> <em>" \
"tip_e=</em> </span>" \
"warn_s=<span class=\"warn\"> <em>" \
"warn_e=</em> </span>" \
ALIASES = "tip_s=<span class=\"tip\">" \
"tip_e=</span>" \
"warn_s=<span class=\"warn\">" \
"warn_e=</span>" \

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
Expand Down Expand Up @@ -706,7 +706,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = doxygen_layout.xml
LAYOUT_FILE = theme/doxygen_layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1153,7 +1153,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 = header.html
HTML_HEADER = theme/doxygen_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
Expand All @@ -1163,7 +1163,7 @@ HTML_HEADER = header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER =
HTML_FOOTER = theme/doxygen_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
Expand All @@ -1188,7 +1188,8 @@ HTML_STYLESHEET =
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET = doxygen_extra.css
HTML_EXTRA_STYLESHEET = theme/doxygen_extra.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
Expand Down Expand Up @@ -1237,7 +1238,7 @@ HTML_COLORSTYLE_GAMMA = 240
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_TIMESTAMP = YES
HTML_TIMESTAMP = NO

# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
# documentation will contain a main index with vertical navigation menus that
Expand Down Expand Up @@ -1499,7 +1500,7 @@ ENUM_VALUES_PER_LINE = 4
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 350
TREEVIEW_WIDTH = 500

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
306 changes: 306 additions & 0 deletions doc/theme/doxygen_extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,306 @@
/*
* GitHub Markdown style CSS for doxygen 1.8.14
* Source: https://github.com/sindresorhus/github-markdown-css
* License: MIT © Sindre Sorhus
*/

* {
box-sizing: border-box;
}

body, table, div, p, dl {
-ms-text-size-adjust: 100%;
-webkit-text-size-adjust: 100%;
line-height: 1.5;
color: #24292e;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
font-size: 16px;
line-height: 1.5;
word-wrap: break-word;
}

b {
font-weight: 600;
}

/* @group Heading Levels */

h1, h2, h3, h4, h5, h6 {
font-weight: 600;
line-height: 1.25;
margin-top: 24px;
margin-bottom: 16px;
}

h1 {
font-size: 2em;
padding-bottom: 0.3em;
border-bottom: 1px solid #eaecef;
}

h2 {
padding-bottom: 0.3em;
font-size: 1.5em;
border-bottom: 1px solid #eaecef;
}

h3 {
font-size: 1.25em;
}

h4 {
font-size: 1em;
}

h5 {
font-size: 0.875em;
}

h6 {
font-size: 0.85em;
color: #6a737d;
}

a {
background-color: transparent;
color: #0366d6;
text-decoration: none;
font-weight: normal;
}

.contents a:visited {
color: #0366d6;
}

a:active, a:hover {
outline-width: 0;
}

a:hover {
text-decoration: underline;
}

a:not([href]) {
color: inherit;
text-decoration: none;
}

a.el {
font-weight: normal;
}

.image {
text-align: left;
}

.tip {
background-image: url(tip.png);
background-position: left center;
background-repeat: no-repeat;
padding-left: 30px;
margin-top: 1em;
margin-bottom: 1em;
min-height: 31px;
display: block;
font-style:italic;
}

.warn {
background-image: url(warn.png);
background-position: left center;
background-repeat: no-repeat;
padding-left: 48px;
margin-top: 1em;
margin-bottom: 1em;
min-height: 31px;
display: block;
font-style:italic;
}

#projectname
{
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
font-size: 2em;
font-weight: bold;
}

#projectbrief
{
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
font-size: 0.8em;
}

#projectnumber
{
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
font-size: 1em;
}

div.contents {
width: 980px;
padding: 40px;
margin-top: -1px;
margin-left: auto;
margin-right: auto;
margin-bottom: 10px;
border: 1px solid #d1d5da;
border-radius: 2px;
}

div.toc {
border: 0px none;
border-radius: 7px 7px 7px 7px;
}

div.header
{
width: 980px;
padding: 10px;
margin-top: 10px;
margin-left: auto;
margin-right: auto;
background-image: none;
background-repeat: none;
background-color: #f6f8fa;
border: 1px solid #d1d5da;
}

div.headertitle
{
padding: 0px;
}

.title ol {
margin: 0px;
}

.title ol li {
list-style-type: none;
}

.ui-resizable .ui-resizable-handle {
}

.ui-resizable-e {
background: none;
background-color: #E6E6E6;
}

.ui-resizable-handle {
}

div.fragment {
padding: 16px;
background-color: #f3f3f3;
border: 0px solid;
}

div.line {
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 85%;
line-height: 1.45;
-webkit-transition-duration: 0;
-moz-transition-duration: 0;
-ms-transition-duration: 0;
-o-transition-duration: 0;
transition-duration: 0;
}

div.line.glow {
background-color: auto;
box-shadow: none;
}

pre.fragment {
border: 0px solid #C4CFE5;
padding: 16px;
background-color: #f3f3f3;
font-size: 85%;
line-height: 1.45;
font-family: "SFMono-Regular", Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 85%;
}

/* @group Code Colorization */
span.keyword {
color: #808000
}

span.keywordtype {
color: #808000
}

span.keywordflow {
color: #808000
}

span.comment {
color: #008000
}

span.preprocessor {
color: #800000
}

span.stringliteral {
color: #000080
}

span.charliteral {
color: #000080
}

blockquote {
background-color: #EEEEEE;
border-left: 2px solid #606060;
margin: 0 24px 0 4px;
padding: 0 12px 0 16px;
}

/* @end */

.arrow {
box-sizing: content-box;
}

img {
max-width: 100%;
max-height: 100%;
}

#nav-tree {
background-image: none;
}

#nav-tree .label {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
font-size: 14px;
}

.memtitle {
background-image: none;
}

.memproto {
text-shadow: none;
/* opera specific markup */
box-shadow: none;
/* firefox specific markup */
-moz-box-shadow: none;
-moz-border-radius-topright: 4px;
/* webkit specific markup */
-webkit-box-shadow: none;
-webkit-border-top-right-radius: 4px;
}

.memdoc {
background-image:none;
background-repeat:repeat-x;
background-color: #FFFFFF;
/* opera specific markup */
box-shadow: none;
/* firefox specific markup */
-moz-box-shadow: none;
/* webkit specific markup */
-webkit-box-shadow: none;
}
10 changes: 10 additions & 0 deletions doc/theme/doxygen_footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
</div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<!--END !GENERATE_TREEVIEW-->
</body>
</html>
Loading

0 comments on commit 9410d63

Please sign in to comment.