From 6644241f7e5432b06245180e707abe06703b5ed8 Mon Sep 17 00:00:00 2001 From: Ben Walker Date: Thu, 5 Jan 2017 16:19:45 -0700 Subject: [PATCH] docs: Match doxygen output to spdk.io Change-Id: Ic042024915bfbee1028154ad5bad11cd14956e51 Signed-off-by: Ben Walker --- doc/Doxyfile | 4 +- doc/footer.html | 71 ++++++++++---------- doc/header.html | 111 +++++++++++++++++++++---------- doc/stylesheet.css | 161 ++++++++++++++++++++++++++++++++++++++------- 4 files changed, 252 insertions(+), 95 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 17b02dda2..a2444531c 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1087,7 +1087,7 @@ HTML_FOOTER = footer.html # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = stylesheet.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 @@ -1100,7 +1100,7 @@ HTML_STYLESHEET = stylesheet.css # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = stylesheet.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 diff --git a/doc/footer.html b/doc/footer.html index 12d1ed26a..b5e3c9ffa 100644 --- a/doc/footer.html +++ b/doc/footer.html @@ -1,57 +1,52 @@ - - - - - - diff --git a/doc/stylesheet.css b/doc/stylesheet.css index 9fca86a38..510c7c747 100644 --- a/doc/stylesheet.css +++ b/doc/stylesheet.css @@ -1,4 +1,121 @@ -/* @group Heading Levels */ +/* SPDK specific */ + +body, +html { + width: 100%; + height: 100%; +} + +body, +h1, +h2, +h3, +h4, +h5, +h6 { + font-family: 'Roboto', sans-serif; + font-weight: 900; +} + +.banner-header { + padding-top: 50px; + padding-bottom: 0px; + text-align: center; + color: #f8f8f8; + background: url(http://www.spdk.io/img/banner-bg.jpg) no-repeat center center; + background-size: cover; +} + +.banner-message { + position: relative; + padding-top: 2%; + padding-bottom: 2%; +} + +.banner-message > h1 { + margin: 0; + text-shadow: 2px 2px 3px rgba(0,0,0,0.6); + font-size: 4em; +} + +.banner-divider { + width: 400px; + border-top: 1px solid #f8f8f8; + border-bottom: 1px solid rgba(0,0,0,0.2); +} + +.banner-message > h3 { + text-shadow: 2px 2px 3px rgba(0,0,0,0.6); +} + +.banner-tabs { + margin-bottom: 0px; +} + +@media(max-width:767px) { + .banner-message { + padding-bottom: 15%; + } + + .banner-message > h1 { + font-size: 3em; + } + + ul.banner-tabs > li { + display: block; + margin-bottom: 0px; + padding: 0; + } + + ul.banner-tabs > li:last-child { + margin-bottom: 0; + } + + .banner-divider { + width: 100%; + } +} + +.box-name { + text-transform: uppercase; + font-size: 14px; + font-weight: 400; + letter-spacing: 1px; + padding-left: 3px; +} + +.community { + padding: 20px 0; + color: #f8f8f8; + background: url(http://www.spdk.io/img/community-bg.jpg) no-repeat center center; + background-size: cover; +} + +.community h2 { + margin: 0; + padding: 50px; + text-shadow: 2px 2px 3px rgba(0,0,0,0.6); + font-size: 3em; +} + +@media(max-width:767px) { + .community h2 { + margin: 0; + text-shadow: 2px 2px 3px rgba(0,0,0,0.6); + font-size: 3em; + } +} + +footer { + padding: 50px 0; + background-color: #f8f8f8; +} + +p.copyright { + margin: 15px 0 0; +} + +/* Original Stylesheet */ h1.groupheader { font-size: 150%; @@ -267,7 +384,7 @@ p.formulaDsp { } img.formulaDsp { - + } img.formulaInl { @@ -325,20 +442,20 @@ span.charliteral { color: #008080 } -span.vhdldigit { - color: #ff00ff +span.vhdldigit { + color: #ff00ff } -span.vhdlchar { - color: #000000 +span.vhdlchar { + color: #000000 } -span.vhdlkeyword { - color: #700070 +span.vhdlkeyword { + color: #700070 } -span.vhdllogic { - color: #ff0000 +span.vhdllogic { + color: #ff0000 } blockquote { @@ -533,9 +650,9 @@ table.memberdecls { } .memdoc, dl.reflist dd { - border-bottom: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; padding: 6px 10px 2px 10px; background-color: #FBFCFD; border-top-width: 0; @@ -587,18 +704,18 @@ dl.reflist dd { .params, .retval, .exception, .tparams { margin-left: 0px; padding-left: 0px; -} +} .params .paramname, .retval .paramname { font-weight: bold; vertical-align: top; } - + .params .paramtype { font-style: italic; vertical-align: top; -} - +} + .params .paramdir { font-family: "courier new",courier,monospace; vertical-align: top; @@ -850,8 +967,8 @@ table.fieldtable { .fieldtable td.fielddoc p:first-child { margin-top: 0px; -} - +} + .fieldtable td.fielddoc p:last-child { margin-bottom: 2px; } @@ -925,7 +1042,7 @@ table.fieldtable { color: #283A5D; font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - text-decoration: none; + text-decoration: none; } .navpath li.navelem a:hover @@ -954,7 +1071,7 @@ div.summary padding-right: 5px; width: 50%; text-align: right; -} +} div.summary a { @@ -1122,7 +1239,7 @@ div.toc ul { list-style: none outside none; border: medium none; padding: 0px; -} +} div.toc li.level1 { margin-left: 0px;