ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Match doxygen output to spdk.io

Browse Source 
Change-Id: Ic042024915bfbee1028154ad5bad11cd14956e51
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Ben Walker 2017-01-05 16:19:45 -07:00
parent a96dc2592e
commit 6644241f7e
4 changed files with 252 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/Doxyfile
View File

@ -1087,7 +1087,7 @@ HTML_FOOTER = footer.html
# obsolete. # obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES. # 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 # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets # 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. # list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES. # 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 # 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 # other source files which should be copied to the HTML output directory. Note

71
doc/footer.html
View File

@ -1,57 +1,52 @@
<!-- start footer part --> <div id="nav-path" class="navpath">
<!--BEGIN GENERATE_TREEVIEW-->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul> <ul>
$navpath $navpath
</ul> </ul>
</div> </div>
<!--END GENERATE_TREEVIEW-->
<!--BEGIN !GENERATE_TREEVIEW-->
<!--END !GENERATE_TREEVIEW-->
<section id="community"> <section id="community">
<div class="community"> <div class="community">
<div class="container"> <div class="container">
<div class="row"> <div class="col-lg-6">
<div class="col-lg-6"> <h2>Join Our Community:</h2>
<h2>Join Our Community:</h2> </div>
</div> <div class="col-lg-6">
<div class="col-lg-6"> <div class="btn-group-vertical" role="group">
<ul class="list-inline community-box-buttons"> <a href="http://www.spdk.io/" class="btn btn-default btn-lg">
<li> <i class="glyphicon glyphicon-home"></i>
<a href="https://github.com/spdk/spdk" class="btn btn-default btn-lg"> <span class="box-name">home</span>
<img class="box-ico" src="http://www.spdk.io/img/ico/github.png"></img> </a>
<span class="box-name">github</span>
</a>
</li>
<li> <a href="https://github.com/spdk/spdk/releases/" class="btn btn-default btn-lg">
<a href="https://lists.01.org/mailman/listinfo/spdk" class="btn btn-default btn-lg"> <i class="glyphicon glyphicon-download-alt"></i>
<img class="box-ico" src="http://www.spdk.io/img/ico/125a-email-message-solid.svg"></img> <span class="box-name">download</span>
<span class="box-name">mailing list</span> </a>
</a>
</li>
<li> <a href="http://www.spdk.io/doc/" class="btn btn-default btn-lg">
<a href="http://www.spdk.io/doc/" class="btn btn-default btn-lg"> <i class="glyphicon glyphicon-book"></i>
<img class="box-ico" src="http://www.spdk.io/img/ico/003-instructions.svg"></img> <span class="box-name">documentation</span>
<span class="box-name">documentation</span> </a>
</a>
</li>
</ul> <a href="https://github.com/spdk/spdk/" class="btn btn-default btn-lg">
<i class="glyphicon glyphicon-wrench"></i>
<span class="box-name">development</span>
</a>
<a href="https://lists.01.org/mailman/listinfo/spdk" class="btn btn-default btn-lg">
<i class="glyphicon glyphicon-envelope"></i>
<span class="box-name">mailing list</span>
</a>
<a href="http://www.spdk.io/blog/" class="btn btn-default btn-lg">
<i class="glyphicon glyphicon-comment"></i>
<span class="box-name">Blog</span>
</a>
</div> </div>
</div> </div>
</div> </div>
<!-- /.container -->
</div> </div>
</section> </section>
<!-- /.banner -->
<!-- Footer -->
<footer> <footer>
<div class="container text-center"> <div class="container text-center">
<p class="copyright text-muted small">Copyright &copy; Intel Corporation. All Rights Reserved.</p> <p class="copyright text-muted small">Copyright © Intel Corporation. All Rights Reserved.</p>
</div> </div>
</footer> </footer>
</body>
</html>

111
doc/header.html
View File

@ -1,40 +1,85 @@
<!-- HTML header for doxygen 1.8.10--> <!DOCTYPE html>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="X-UA-Compatible" content="IE=9"/> <!-- For Mobile Devices -->
<meta name="generator" content="Doxygen $doxygenversion"/> <meta name="viewport" content="width=device-width, initial-scale=1">
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME--> <meta http-equiv="Content-Type" content="text/xhtml; charset=utf-8">
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME--> <meta name="generator" content="Doxygen $doxygenversion">
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath^jquery.js"></script> <title>$projectname: $title</title>
<link href="https://fonts.googleapis.com/css?family=Roboto:400,900" rel="stylesheet" type="text/css">
<script type="text/javascript" src="$relpath^dynsections.js"></script> <script type="text/javascript" src="$relpath^jquery.js"></script>
$treeview <script type="text/javascript" src="$relpath^dynsections.js"></script>
$search
$mathjax $treeview
<link href="http://www.spdk.io/css/bootstrap.min.css" rel="stylesheet"> $search
<link href="http://www.spdk.io/css/spdk.css" rel="stylesheet" type="text/css"> $mathjax
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:400,900" type="text/css">
<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<link rel="stylesheet" href="$relpath^tabs.css" type="text/css">
$extrastylesheet
</head> </head>
<body> <body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="top"> <!-- do not remove this div, it is closed by doxygen! -->
<!--BEGIN TITLEAREA--> <div class="row">
<section id="page"> <div class="col-lg-12">
<div class="page-header"> <section id="banner-header" class="banner-header">
<div class="container"> <div class="banner-message">
<div class="row"> <h1>Storage Performance Development Kit</h1>
<div class="col-lg-12"> <hr class="banner-divider">
<div class="page-title">
<h1><a href="http://www.spdk.io">Storage Performance Development Kit</a></h1>
</div> </div>
</div> </section>
<section id="nav">
<div class="navbar navbar-default banner-tabs">
<ul class="nav navbar-nav">
<li role="presentation">
<a href="http://www.spdk.io/">
<i class="glyphicon glyphicon-home"></i>
<span class="box-name">home</span>
</a>
</li>
<li role="presentation">
<a href="https://github.com/spdk/spdk/releases/">
<i class="glyphicon glyphicon-download-alt"></i>
<span class="box-name">download</span>
</a>
</li>
<li role="presentation">
<a href="http://www.spdk.io/doc/">
<i class="glyphicon glyphicon-book"></i>
<span class="box-name">documentation</span>
</a>
</li>
<li role="presentation">
<a href="https://github.com/spdk/spdk/">
<i class="glyphicon glyphicon-wrench"></i>
<span class="box-name">development</span>
</a>
</li>
<li role="presentation">
<a href="https://lists.01.org/mailman/listinfo/spdk">
<i class="glyphicon glyphicon-envelope"></i>
<span class="box-name">mailing list</span>
</a>
</li>
<li role="presentation">
<a href="http://www.spdk.io/blog/">
<i class="glyphicon glyphicon-comment"></i>
<span class="box-name">Blog</span>
</a>
</li>
</ul>
</div>
</section>
</div> </div>
</div> </div>
</div>
</section>
<!--END TITLEAREA-->
<!-- end header part -->

161
doc/stylesheet.css
View File

@ -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 { h1.groupheader {
font-size: 150%; font-size: 150%;
@ -267,7 +384,7 @@ p.formulaDsp {
} }
img.formulaDsp { img.formulaDsp {
} }
img.formulaInl { img.formulaInl {
@ -325,20 +442,20 @@ span.charliteral {
color: #008080 color: #008080
} }
span.vhdldigit { span.vhdldigit {
color: #ff00ff color: #ff00ff
} }
span.vhdlchar { span.vhdlchar {
color: #000000 color: #000000
} }
span.vhdlkeyword { span.vhdlkeyword {
color: #700070 color: #700070
} }
span.vhdllogic { span.vhdllogic {
color: #ff0000 color: #ff0000
} }
blockquote { blockquote {
@ -533,9 +650,9 @@ table.memberdecls {
} }
.memdoc, dl.reflist dd { .memdoc, dl.reflist dd {
border-bottom: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9; border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9; border-right: 1px solid #A8B8D9;
padding: 6px 10px 2px 10px; padding: 6px 10px 2px 10px;
background-color: #FBFCFD; background-color: #FBFCFD;
border-top-width: 0; border-top-width: 0;
@ -587,18 +704,18 @@ dl.reflist dd {
.params, .retval, .exception, .tparams { .params, .retval, .exception, .tparams {
margin-left: 0px; margin-left: 0px;
padding-left: 0px; padding-left: 0px;
} }
.params .paramname, .retval .paramname { .params .paramname, .retval .paramname {
font-weight: bold; font-weight: bold;
vertical-align: top; vertical-align: top;
} }
.params .paramtype { .params .paramtype {
font-style: italic; font-style: italic;
vertical-align: top; vertical-align: top;
} }
.params .paramdir { .params .paramdir {
font-family: "courier new",courier,monospace; font-family: "courier new",courier,monospace;
vertical-align: top; vertical-align: top;
@ -850,8 +967,8 @@ table.fieldtable {
.fieldtable td.fielddoc p:first-child { .fieldtable td.fielddoc p:first-child {
margin-top: 0px; margin-top: 0px;
} }
.fieldtable td.fielddoc p:last-child { .fieldtable td.fielddoc p:last-child {
margin-bottom: 2px; margin-bottom: 2px;
} }
@ -925,7 +1042,7 @@ table.fieldtable {
color: #283A5D; color: #283A5D;
font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
text-decoration: none; text-decoration: none;
} }
.navpath li.navelem a:hover .navpath li.navelem a:hover
@ -954,7 +1071,7 @@ div.summary
padding-right: 5px; padding-right: 5px;
width: 50%; width: 50%;
text-align: right; text-align: right;
} }
div.summary a div.summary a
{ {
@ -1122,7 +1239,7 @@ div.toc ul {
list-style: none outside none; list-style: none outside none;
border: medium none; border: medium none;
padding: 0px; padding: 0px;
} }
div.toc li.level1 { div.toc li.level1 {
margin-left: 0px; margin-left: 0px;