Commit 6644241f authored by Ben Walker's avatar Ben Walker
Browse files

docs: Match doxygen output to spdk.io 



Change-Id: Ic042024915bfbee1028154ad5bad11cd14956e51
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent a96dc259

doc/Doxyfile

+2 −2
Original line number Diff line number Diff line
@@ -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

doc/footer.html

+33 −38
Original line number Diff line number Diff line 
<!-- start footer part -->

<!--BEGIN GENERATE_TREEVIEW-->

<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

<div id="nav-path" class="navpath">

  <ul>

    $navpath

  </ul>

</div>

<!--END GENERATE_TREEVIEW-->

<!--BEGIN !GENERATE_TREEVIEW-->

<!--END !GENERATE_TREEVIEW-->

<section id="community">

  <div class="community">

    <div class="container">

      <div class="row">

      <div class="col-lg-6">

        <h2>Join Our Community:</h2>

      </div>

      <div class="col-lg-6">

          <ul class="list-inline community-box-buttons">

            <li>

              <a href="https://github.com/spdk/spdk" class="btn btn-default btn-lg">

                <img class="box-ico" src="http://www.spdk.io/img/ico/github.png"></img>

                <span class="box-name">github</span>

        <div class="btn-group-vertical" role="group">

          <a href="http://www.spdk.io/" class="btn btn-default btn-lg">

            <i class="glyphicon glyphicon-home"></i>

            <span class="box-name">home</span>

          </a>

            </li>



            <li>

              <a href="https://lists.01.org/mailman/listinfo/spdk" class="btn btn-default btn-lg">

                <img class="box-ico" src="http://www.spdk.io/img/ico/125a-email-message-solid.svg"></img>

                <span class="box-name">mailing list</span>

          <a href="https://github.com/spdk/spdk/releases/" class="btn btn-default btn-lg">

            <i class="glyphicon glyphicon-download-alt"></i>

            <span class="box-name">download</span>

          </a>

            </li>



            <li>

          <a href="http://www.spdk.io/doc/" class="btn btn-default btn-lg">

                <img class="box-ico" src="http://www.spdk.io/img/ico/003-instructions.svg"></img>

            <i class="glyphicon glyphicon-book"></i>

            <span class="box-name">documentation</span>

          </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>

  <!-- /.container -->

  </div>

</section>

<!-- /.banner -->



<!-- Footer -->

<footer>

  <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>

</footer>
 
</body>

</html>

doc/header.html

+79 −34
Original line number Diff line number Diff line 
<!-- HTML header for doxygen 1.8.10-->

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">

<!DOCTYPE html>

<html>

<head>

<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

<meta http-equiv="X-UA-Compatible" content="IE=9"/>

<meta name="generator" content="Doxygen $doxygenversion"/>

<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->

<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->

<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>

  <meta http-equiv="X-UA-Compatible" content="IE=edge">

  <!-- For Mobile Devices -->

  <meta name="viewport" content="width=device-width, initial-scale=1">

  <meta http-equiv="Content-Type" content="text/xhtml; charset=utf-8">

  <meta name="generator" content="Doxygen $doxygenversion">



  <title>$projectname: $title</title>



  <script type="text/javascript" src="$relpath^jquery.js"></script>

<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>



  $treeview

  $search

  $mathjax

<link href="http://www.spdk.io/css/bootstrap.min.css" rel="stylesheet">

<link href="http://www.spdk.io/css/spdk.css" rel="stylesheet" type="text/css">

<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />



  <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>

<body>

  <div id="top">  <!-- do not remove this div, it is closed by doxygen! -->



<!--BEGIN TITLEAREA-->

<section id="page">

  <div class="page-header">

    <div class="container">

    <div class="row">

      <div class="col-lg-12">

          <div class="page-title">

            <h1><a href="http://www.spdk.io">Storage Performance Development Kit</a></h1>

          </div>

        <section id="banner-header" class="banner-header">

          <div class="banner-message">

            <h1>Storage Performance Development Kit</h1>

            <hr class="banner-divider">

          </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>
 
</section>

<!--END TITLEAREA-->

<!-- end header part -->

doc/stylesheet.css

+139 −22
Original line number Diff line number Diff line 
/* @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%;