Merge pull request #4869 from NREL/MarkdownDocs

Convert EnergyPlus Documentation to a Markdown Basis
NREL · Apr 22, 2015 · 3f529b7 · 3f529b7 · nrel-bot · Apr 22, 2015
2 parents da91c81 + 7c601af
commit 3f529b7
Show file tree

Hide file tree

Showing 929 changed files with 394,289 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,6 +22,9 @@
 # now that we have python, ignore some things
 *.pyc
 
+# ignore the site build folder for mkdocs
+doc/src/site
+
 # build folder, if the dev chooses to put it there
 #  could also do a wildcard for build-* if we suggest that naming approach
 #  which could be useful for: build-eclipse, build-vs2013, build, etc.

diff --git a/doc/src/bootstrap_nrel/base.html b/doc/src/bootstrap_nrel/base.html
@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>{{ page_title }}</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    {% if page_description %}<meta name="description" content="{{ page_description }}">{% endif %}
+    {% if site_author %}<meta name="author" content="{{ site_author }}">{% endif %}
+    {% if canonical_url %}<link rel="canonical" href="{{ canonical_url }}">{% endif %}
+    {% if favicon %}<link rel="shortcut icon" href="{{ favicon }}">
+    {% else %}<link rel="shortcut icon" href="{{ base_url }}/img/favicon.ico">{% endif %}
+    <link href="{{ base_url }}/css/bootstrap-3.3.4.min.css" rel="stylesheet">
+    <link href="{{ base_url }}/css/font-awesome-4.3.0.min.css" rel="stylesheet">
+    <link href="{{ base_url }}/css/prettify-1.0.css" rel="stylesheet">
+    <link href="{{ base_url }}/css/base.css" rel="stylesheet">
+    {%- for path in extra_css %}
+    <link href="{{ path }}" rel="stylesheet">
+    {%- endfor %}
+    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!--[if lt IE 9]>
+      <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+      <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+    <![endif]-->
+    <link href="http://netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
+  </head>
+  <body>
+    {% include "nav.html" %}
+    <div class="container">
+      <div class="row">
+        <div class="col-md-3">
+          {% include "toc.html" %}
+        </div>
+        <div class="col-md-9" role="main">
+          <script>
+           (function() {
+            var cx = '007045650438215436378:sghdz0ne6rg';
+            var gcse = document.createElement('script');
+            gcse.type = 'text/javascript';
+            gcse.async = true;
+            gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+                '//www.google.com/cse/cse.js?cx=' + cx;
+            var s = document.getElementsByTagName('script')[0];
+            s.parentNode.insertBefore(gcse, s);
+           })();
+          </script>
+          <gcse:search></gcse:search>
+          {% include "content.html" %}
+          {% include "footer.html" %}
+        </div>
+      </div>
+    </div>
+    {% if include_search %}{% include "search.html" %}{% endif %}
+
+    <script src="{{ base_url }}/js/jquery-2.1.3.min.js"></script>
+    <script src="{{ base_url }}/js/bootstrap-3.3.4.min.js"></script>
+    <script src="{{ base_url }}/js/bootstrap-hover-dropdown-2.1.3.min.js"></script>
+    <script src="{{ base_url }}/js/prettify-1.0.min.js"></script>
+    <script src="{{ base_url }}/js/base.js"></script>
+    {%- for path in extra_javascript %}
+    <script src="{{ path }}"></script>
+    {%- endfor %}
+    <script type="text/x-mathjax-config">
+      MathJax.Hub.Config({
+        extensions: ["tex2jax.js"],
+        jax: ["input/TeX", "output/HTML-CSS"],
+        showMathMenu: true,
+        showMathMenuMSIE: false,
+        "HTML-CSS": {
+          imageFont: null,
+          preferredFont: null
+        },
+        tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}
+      });
+    </script>
+    <script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js'></script>
+    <script>
+      $(function() {
+        return $("h2, h3, h4, h5, h6").each(function(i, el) {
+          var $el, icon, id;
+          $el = $(el);
+          id = $el.attr('id');
+          icon = '<i class="fa fa-link"></i>';
+          if (id) {
+            return $el.prepend($("<a />").addClass("header-link").attr("href", "#" + id).html(icon));
+          }
+        });
+      });
+    </script>
+  </body>
+</html>
diff --git a/doc/src/bootstrap_nrel/content.html b/doc/src/bootstrap_nrel/content.html
@@ -0,0 +1 @@
+{{ content }}
diff --git a/doc/src/bootstrap_nrel/css/base.css b/doc/src/bootstrap_nrel/css/base.css
@@ -0,0 +1,170 @@
+body {
+    padding-top: 70px;
+}
+
+ul.nav li.main {
+    font-weight: bold;
+}
+
+div.col-md-3 {
+    padding-left: 0;
+}
+
+.footer {
+    border-top: 1px solid #ccc;
+    margin-top: 30px;
+    padding-top: 20px;
+    font-size: 85%;
+}
+
+.home-btn {
+    padding: 0 20px 10px;
+}
+
+.container p img {
+    max-width: 100%;
+}
+
+.container iframe {
+    border: 0 none;
+}
+
+a.navbar-brand > img {
+    display: inline;
+    height: 26px;
+    margin-top: -4px;
+}
+
+/*
+ * Side navigation
+ *
+ * Scrollspy and affixed enhanced navigation to highlight sections and secondary
+ * sections of docs content.
+ */
+
+/* By default it's not affixed in mobile views, so undo that */
+.bs-docs-sidebar.affix {
+    margin-left: 15px;
+    position: static;
+}
+
+.bs-docs-sidebar.well {
+    padding: 0;
+}
+
+/* sidebar */
+.bs-docs-sidebar {
+    padding-left: 20px;
+    padding-bottom: 20px;
+}
+
+/* Show and affix the side nav when space allows it */
+@media (min-width: 992px) {
+    .bs-docs-sidebar .nav > .active > ul {
+        display: block;
+    }
+    /* Widen the fixed sidebar */
+    .bs-docs-sidebar.affix,
+    .bs-docs-sidebar.affix-bottom {
+        width: 213px;
+    }
+    .bs-docs-sidebar.affix {
+        position: fixed; /* Undo the static from mobile first approach */
+    }
+    .bs-docs-sidebar.affix-bottom {
+        position: absolute; /* Undo the static from mobile first approach */
+    }
+}
+@media (min-width: 1200px) {
+    /* Widen the fixed sidebar again */
+    .bs-docs-sidebar.affix-bottom,
+    .bs-docs-sidebar.affix {
+        width: 263px;
+    }
+}
+
+/* all links */
+.bs-docs-sidebar .nav>li>a {
+    color: #999;
+    border-left: 2px solid transparent;
+    padding: 4px 20px;
+    font-size: 13px;
+    font-weight: 400;
+}
+
+/* nested links */
+.bs-docs-sidebar .nav .nav>li>a {
+    padding-top: 1px;
+    padding-bottom: 1px;
+    padding-left: 30px;
+    font-size: 12px;
+}
+
+/* active & hover links */
+.bs-docs-sidebar .nav>.active>a,
+.bs-docs-sidebar .nav>li>a:hover,
+.bs-docs-sidebar .nav>li>a:focus {
+    color: #563d7c;
+    text-decoration: none;
+    background-color: transparent;
+    border-left-color: #563d7c;
+}
+/* all active links */
+.bs-docs-sidebar .nav>.active>a,
+.bs-docs-sidebar .nav>.active:hover>a,
+.bs-docs-sidebar .nav>.active:focus>a {
+    font-weight: 700;
+}
+/* nested active links */
+.bs-docs-sidebar .nav .nav>.active>a,
+.bs-docs-sidebar .nav .nav>.active:hover>a,
+.bs-docs-sidebar .nav .nav>.active:focus>a {
+    font-weight: 500;
+}
+
+/* hide inactive nested list */
+.bs-docs-sidebar .nav ul.nav {
+    display: none;
+}
+/* show active nested list */
+.bs-docs-sidebar .nav>.active>ul.nav {
+    display: block;
+}
+
+/* make sidebar scrollable */
+.bs-docs-sidebar > ul {
+    overflow-y: auto;
+    height: 100%;
+    padding-top: 20px;
+}
+
+.header-link {
+  position: absolute;
+  left: -0.5em;
+  opacity: 0;
+
+  -webkit-transition: opacity 0.2s ease-in-out 0.1s;
+  -moz-transition: opacity 0.2s ease-in-out 0.1s;
+  -ms-transition: opacity 0.2s ease-in-out 0.1s;
+}
+
+h2:hover .header-link,
+h3:hover .header-link,
+h4:hover .header-link,
+h5:hover .header-link,
+h6:hover .header-link {
+  opacity: 1;
+}
+
+.box {
+    display: flex;
+    flex-direction: row;
+    flex-wrap: wrap;
+    justify-content: center;
+    align-items: center;
+}
+
+img {
+    display: block;
+    margin-left: auto;
+    margin-right: auto }
diff --git a/doc/src/bootstrap_nrel/css/bootstrap-3.3.4.min.css b/doc/src/bootstrap_nrel/css/bootstrap-3.3.4.min.css
diff --git a/doc/src/bootstrap_nrel/css/font-awesome-4.3.0.min.css b/doc/src/bootstrap_nrel/css/font-awesome-4.3.0.min.css
diff --git a/doc/src/bootstrap_nrel/css/prettify-1.0.css b/doc/src/bootstrap_nrel/css/prettify-1.0.css
@@ -0,0 +1,28 @@
+.com { color: #93a1a1; }
+.lit { color: #195f91; }
+.pun, .opn, .clo { color: #93a1a1; }
+.fun { color: #dc322f; }
+.str, .atv { color: #D14; }
+.kwd, .prettyprint .tag { color: #1e347b; }
+.typ, .atn, .dec, .var { color: teal; }
+.pln { color: #48484c; }
+
+.prettyprint {
+    padding: 8px;
+}
+.prettyprint.linenums {
+  -webkit-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+     -moz-box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+          box-shadow: inset 40px 0 0 #fbfbfc, inset 41px 0 0 #ececf0;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin: 0 0 0 33px; /* IE indents via margin-left */
+}
+ol.linenums li {
+  padding-left: 12px;
+  color: #bebec5;
+  line-height: 20px;
+  text-shadow: 0 1px 0 #fff;
+}
diff --git a/doc/src/bootstrap_nrel/fonts/fontawesome-webfont.eot b/doc/src/bootstrap_nrel/fonts/fontawesome-webfont.eot