RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

doc: beautify HTML documentation

Browse Source 
* add logo
* add description
* use RIOT specific color scheme
* add search functionality
* remove broken custom header, footer, and style sheet
This commit is contained in:
Oleg Hahm 2014-10-23 16:51:03 +02:00
parent b066433bdc
commit c0bcac460e
3 changed files with 119 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/doxygen/riot.doxyfile
View File

@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME = RIOT
PROJECT_NAME =
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
@ -44,14 +44,14 @@ PROJECT_NUMBER =
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
PROJECT_BRIEF = "The friendly Operating System for the Internet of Things"
# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
# the documentation. The maximum height of the logo should not exceed 55 pixels
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
# to the output directory.
PROJECT_LOGO =
PROJECT_LOGO = src/riot-logo.svg
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
@ -1059,7 +1059,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 = src/riot-header.html
HTML_HEADER =
# 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
@ -1069,7 +1069,7 @@ HTML_HEADER = src/riot-header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = src/riot-footer.html
HTML_FOOTER =
# 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
@ -1081,7 +1081,7 @@ HTML_FOOTER = src/riot-footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = src/riot.css
HTML_STYLESHEET =
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@ -1115,7 +1115,7 @@ HTML_EXTRA_FILES =
# Minimum value: 0, maximum value: 359, default value: 220.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_HUE = 354
# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
# in the HTML output. For a value of 0 the output will use grayscales only. A
@ -1123,7 +1123,7 @@ HTML_COLORSTYLE_HUE = 220
# Minimum value: 0, maximum value: 255, default value: 100.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_SAT = 86
# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
# luminance component of the colors in the HTML output. Values below 100
@ -1134,7 +1134,7 @@ HTML_COLORSTYLE_SAT = 100
# Minimum value: 40, maximum value: 240, default value: 80.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE_GAMMA = 80
HTML_COLORSTYLE_GAMMA = 74
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting this
@ -1493,7 +1493,7 @@ MATHJAX_CODEFILE =
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = NO
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using Javascript. There

BIN
doc/doxygen/src/riot-logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.0 KiB

109
doc/doxygen/src/riot-logo.svg Normal file
View File

@ -0,0 +1,109 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
id="svg3004"
version="1.1"
inkscape:version="0.48.5 r10040"
width="101"
height="54.691921"
xml:space="preserve"
sodipodi:docname="riot-logo.svg"><metadata
id="metadata3010"><rdf:RDF><cc:Work
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
id="defs3008"><clipPath
clipPathUnits="userSpaceOnUse"
id="clipPath3018"><path
d="M 0,600 600,600 600,0 0,0 0,600 z"
id="path3020"
inkscape:connector-curvature="0" /></clipPath></defs><sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1678"
inkscape:window-height="1029"
id="namedview3006"
showgrid="false"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:zoom="1.1173333"
inkscape:cx="-144.61402"
inkscape:cy="7.7685189"
inkscape:window-x="1920"
inkscape:window-y="19"
inkscape:window-maximized="0"
inkscape:current-layer="g3012" /><g
id="g3012"
inkscape:groupmode="layer"
inkscape:label="Logo"
transform="matrix(1.25,0,0,-1.25,-310.18681,421.9234)"><g
id="g3014"
transform="matrix(0.20267583,0,0,0.20267583,230.06745,251.68491)"
inkscape:export-xdpi="90"
inkscape:export-ydpi="90"
inkscape:export-filename="/home/oleg/git/RIOT/doc/doxygen/src/riot-logo.png"><g
id="g3016"
clip-path="url(#clipPath3018)"><g
id="g3022"
transform="translate(304.752,236.6328)"><path
d="m 0,0 0,88.155 c 0,3.952 3.344,7.296 7.295,7.296 4.104,0 7.297,-3.344 7.297,-7.296 L 14.592,0 c 0,-4.104 -3.193,-7.297 -7.297,-7.297 C 3.344,-7.297 0,-4.104 0,0"
style="fill:#4da98c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3024"
inkscape:connector-curvature="0" /></g><g
id="g3026"
transform="translate(359.3184,306.5493)"><path
d="m 0,0 0,-51.678 c 0,-6.08 4.863,-10.944 10.943,-10.944 6.08,0 10.944,4.864 10.944,10.944 l 0,51.678 c 0,6.079 -4.864,10.943 -10.944,10.943 C 4.863,10.943 0,6.079 0,0 m -14.592,-51.678 0,51.678 c 0,14.135 11.401,25.534 25.535,25.534 14.136,0 25.536,-11.399 25.536,-25.534 l 0,-51.678 c 0,-14.135 -11.4,-25.535 -25.536,-25.535 -14.134,0 -25.535,11.4 -25.535,25.535"
style="fill:#4da98c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3028"
inkscape:connector-curvature="0" /></g><g
id="g3030"
transform="translate(458.877,331.4756)"><path
d="m 0,0 c 4.104,0 7.296,-3.344 7.296,-7.295 0,-4.104 -3.192,-7.296 -7.296,-7.296 l -12.463,0 0,-80.252 c 0,-4.103 -3.192,-7.297 -7.297,-7.297 -3.951,0 -7.295,3.194 -7.295,7.297 l 0,80.252 -12.463,0 c -3.952,0 -7.296,3.192 -7.296,7.296 0,3.951 3.344,7.295 7.296,7.295 L 0,0 z"
style="fill:#4da98c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3032"
inkscape:connector-curvature="0" /></g><g
id="g3034"
transform="translate(304.752,236.6328)"><path
d="m 0,0 0,88.155 c 0,3.952 3.344,7.296 7.295,7.296 4.104,0 7.297,-3.344 7.297,-7.296 L 14.592,0 c 0,-4.104 -3.193,-7.297 -7.297,-7.297 C 3.344,-7.297 0,-4.104 0,0"
style="fill:#4da98c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3036"
inkscape:connector-curvature="0" /></g><g
id="g3038"
transform="translate(359.3184,306.5493)"><path
d="m 0,0 0,-51.678 c 0,-6.08 4.863,-10.944 10.943,-10.944 6.08,0 10.944,4.864 10.944,10.944 l 0,51.678 c 0,6.079 -4.864,10.943 -10.944,10.943 C 4.863,10.943 0,6.079 0,0 m -14.592,-51.678 0,51.678 c 0,14.135 11.401,25.534 25.535,25.534 14.136,0 25.536,-11.399 25.536,-25.534 l 0,-51.678 c 0,-14.135 -11.4,-25.535 -25.536,-25.535 -14.134,0 -25.535,11.4 -25.535,25.535"
style="fill:#4da98c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3040"
inkscape:connector-curvature="0" /></g><g
id="g3042"
transform="translate(458.877,331.4756)"><path
d="m 0,0 c 4.104,0 7.296,-3.344 7.296,-7.295 0,-4.104 -3.192,-7.296 -7.296,-7.296 l -12.463,0 0,-80.252 c 0,-4.103 -3.192,-7.297 -7.297,-7.297 -3.951,0 -7.295,3.194 -7.295,7.297 l 0,80.252 -12.463,0 c -3.952,0 -7.296,3.192 -7.296,7.296 0,3.951 3.344,7.295 7.296,7.295 L 0,0 z"
style="fill:#4da98c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3044"
inkscape:connector-curvature="0" /></g><g
id="g3046"
transform="translate(254.7153,234.0664)"><path
d="m 0,0 -22.582,42.81 c -2.415,4.578 -0.661,10.247 3.917,12.662 4.381,2.31 9.777,0.777 12.348,-3.368 L 19.102,10.914 C 22.293,5.741 20.688,-1.04 15.515,-4.231 10.342,-7.424 3.561,-5.818 0.369,-0.646 0.243,-0.441 0.111,-0.209 0,0"
style="fill:#be353c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3048"
inkscape:connector-curvature="0" /></g><g
id="g3050"
transform="translate(226.0498,329.0859)"><path
d="m 0,0 c 0,0 0.409,0.107 1.2,0.315 0.147,0.042 0.312,0.088 0.495,0.139 0.211,0.064 0.443,0.133 0.694,0.209 0.504,0.156 1.09,0.348 1.755,0.578 2.644,0.939 6.628,2.567 11.243,5.425 4.567,2.839 9.85,6.956 13.865,12.546 4.01,5.6 6.417,12.409 5.113,20.32 -0.303,1.98 -0.86,4.03 -1.613,6.125 -0.085,0.262 -0.2,0.524 -0.299,0.787 l -0.154,0.395 -0.076,0.199 c 0.159,-0.341 -0.411,0.903 0.347,-0.74 l -0.062,0.121 -0.495,0.965 -0.249,0.485 -0.123,0.239 -0.092,0.154 c -0.26,0.422 -0.433,0.794 -0.748,1.276 -0.297,0.464 -0.578,0.95 -0.9,1.388 -2.474,3.637 -5.601,6.492 -9.327,8.243 -3.716,1.754 -8.159,2.413 -12.918,1.777 -4.745,-0.615 -9.708,-2.563 -14.111,-5.536 -4.412,-2.965 -8.258,-6.983 -10.858,-11.573 -1.318,-2.287 -2.291,-4.721 -2.946,-7.212 -0.316,-1.249 -0.538,-2.514 -0.681,-3.79 -0.076,-0.637 -0.111,-1.278 -0.142,-1.921 l -0.055,-2.586 c -0.059,-1.836 0.005,-3.515 0.005,-5.279 0.014,-1.746 0.028,-3.495 0.042,-5.246 -0.01,-3.462 0.132,-7.105 0.243,-10.72 0.113,-3.618 0.225,-7.243 0.338,-10.871 0.121,-3.629 0.196,-7.254 0.408,-10.905 0.365,-7.29 0.729,-14.58 1.093,-21.842 0.181,-3.631 0.362,-7.255 0.543,-10.868 l 0.135,-2.708 0.096,-3.002 -0.013,-3.282 c -0.046,-1.043 -0.077,-2.08 -0.143,-3.123 -0.548,-8.322 -2.527,-16.92 -6.72,-24.735 -2.104,-3.885 -4.713,-7.55 -7.812,-10.744 -3.081,-3.207 -6.62,-5.949 -10.406,-8.117 -7.589,-4.365 -16.066,-6.424 -24.257,-6.492 -8.207,-0.069 -16.232,1.801 -23.332,5.443 -7.094,3.615 -13.227,9.161 -17.295,15.809 -1.003,1.664 -1.913,3.368 -2.666,5.117 -0.202,0.432 -0.372,0.874 -0.544,1.315 l -0.554,1.446 c -0.232,0.684 -0.464,1.364 -0.695,2.041 -0.261,0.843 -0.538,1.839 -0.789,2.748 -0.251,0.925 -0.395,1.719 -0.59,2.58 -0.2,0.841 -0.304,1.687 -0.447,2.526 -0.149,0.839 -0.24,1.676 -0.323,2.508 -1.382,13.357 2.091,25.477 7.548,34.735 2.702,4.665 5.965,8.607 9.338,11.851 3.38,3.248 6.894,5.778 10.222,7.734 1.657,1 3.294,1.795 4.833,2.548 0.776,0.354 1.542,0.665 2.276,0.979 0.732,0.322 1.449,0.603 2.148,0.839 1.392,0.505 2.684,0.955 3.885,1.276 1.196,0.356 2.285,0.658 3.268,0.861 0.982,0.217 1.848,0.434 2.598,0.569 0.751,0.127 1.383,0.233 1.891,0.319 1.018,0.169 1.543,0.255 1.543,0.255 5.101,0.843 9.919,-2.609 10.762,-7.71 0.834,-5.051 -2.543,-9.825 -7.562,-10.735 l -0.546,-0.099 c 0,0 -0.378,-0.068 -1.111,-0.201 -0.366,-0.064 -0.821,-0.144 -1.362,-0.239 -0.538,-0.1 -1.143,-0.269 -1.838,-0.426 -0.702,-0.144 -1.457,-0.369 -2.284,-0.626 -0.842,-0.224 -1.721,-0.551 -2.669,-0.904 -0.483,-0.161 -0.967,-0.358 -1.456,-0.584 -0.494,-0.217 -1.004,-0.441 -1.531,-0.672 -1.018,-0.523 -2.114,-1.053 -3.196,-1.73 -4.349,-2.617 -9.13,-6.734 -12.658,-12.928 -0.914,-1.52 -1.66,-3.208 -2.385,-4.955 -0.688,-1.767 -1.252,-3.64 -1.716,-5.59 -0.851,-3.911 -1.2,-8.173 -0.681,-12.449 0.057,-0.535 0.115,-1.072 0.221,-1.601 0.102,-0.527 0.157,-1.073 0.298,-1.592 0.126,-0.506 0.234,-1.103 0.365,-1.541 0.128,-0.451 0.257,-0.904 0.386,-1.358 0.237,-0.675 0.475,-1.352 0.715,-2.033 0.027,-0.079 -0.068,0.193 -0.011,0.038 l 0.036,-0.087 0.072,-0.175 0.141,-0.35 c 0.092,-0.235 0.181,-0.472 0.296,-0.697 0.404,-0.925 0.901,-1.809 1.43,-2.682 2.172,-3.447 5.452,-6.436 9.604,-8.509 4.133,-2.077 9.085,-3.211 14.11,-3.109 5.023,0.089 10.09,1.42 14.408,3.969 4.332,2.541 7.891,6.288 10.36,10.993 2.468,4.708 3.827,10.369 4.166,16.428 l 0.083,2.291 -0.005,2.148 -0.094,2.432 -0.161,2.731 c -0.214,3.644 -0.429,7.299 -0.644,10.961 -0.43,7.325 -0.862,14.678 -1.294,22.031 -0.246,3.669 -0.356,7.375 -0.511,11.066 -0.147,3.692 -0.294,7.381 -0.441,11.063 -0.144,3.684 -0.32,7.325 -0.346,11.132 -0.03,1.882 -0.06,3.762 -0.09,5.638 -0.016,1.858 -0.091,3.796 -0.048,5.568 l 0.039,2.821 c 0.045,1.157 0.112,2.311 0.239,3.46 0.245,2.296 0.642,4.57 1.198,6.792 1.133,4.434 2.841,8.66 5.035,12.515 4.373,7.741 10.468,14.066 17.43,18.803 6.971,4.726 14.882,7.962 23.265,9.114 4.183,0.567 8.475,0.632 12.712,0.036 4.235,-0.567 8.401,-1.789 12.247,-3.573 7.742,-3.572 13.875,-9.412 18.058,-15.548 0.548,-0.763 1.025,-1.545 1.516,-2.321 0.486,-0.751 0.987,-1.682 1.464,-2.515 l 0.179,-0.321 0.127,-0.245 0.251,-0.483 0.499,-0.964 0.062,-0.12 c 0.8,-1.722 0.257,-0.565 0.45,-0.989 l 0.122,-0.304 0.24,-0.609 c 0.157,-0.409 0.325,-0.807 0.468,-1.222 1.198,-3.281 2.136,-6.669 2.688,-10.124 C 56.985,36.11 56.575,29.015 54.83,22.748 53.109,16.457 50.242,11.023 47.056,6.545 43.857,2.05 40.356,-1.578 36.93,-4.58 c -3.433,-3.003 -6.801,-5.399 -9.945,-7.367 -6.294,-3.925 -11.697,-6.166 -15.513,-7.536 -0.957,-0.337 -1.814,-0.621 -2.561,-0.854 -0.375,-0.115 -0.722,-0.22 -1.037,-0.316 -0.348,-0.098 -0.661,-0.187 -0.941,-0.266 -0.925,-0.248 -1.403,-0.375 -1.403,-0.375 -5.87,-1.566 -11.898,1.923 -13.464,7.793 -1.566,5.87 1.923,11.897 7.793,13.464 l 0.037,0.01 L 0,0 z"
style="fill:#be353c;fill-opacity:1;fill-rule:nonzero;stroke:none"
id="path3052"
inkscape:connector-curvature="0" /></g></g></g></g></svg>
Side by Side

After

Width:  |  Height:  |  Size: 11 KiB