deploy: update docs

ladybug-tools · Nov 25, 2023 · 42f643b · 42f643b
commit 42f643b
Show file tree

Hide file tree

Showing 127 changed files with 41,095 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -0,0 +1 @@
+
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+# documentation
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5e1e6d84b4dc6d420c9e55eedc2d2415
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/cli/index.doctree b/docs/.doctrees/cli/index.doctree
diff --git a/docs/.doctrees/cli/main.doctree b/docs/.doctrees/cli/main.doctree
diff --git a/docs/.doctrees/cli/translate.doctree b/docs/.doctrees/cli/translate.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/honeybee_ies.cli.doctree b/docs/.doctrees/honeybee_ies.cli.doctree
diff --git a/docs/.doctrees/honeybee_ies.cli.translate.doctree b/docs/.doctrees/honeybee_ies.cli.translate.doctree
diff --git a/docs/.doctrees/honeybee_ies.doctree b/docs/.doctrees/honeybee_ies.doctree
diff --git a/docs/.doctrees/honeybee_ies.reader.doctree b/docs/.doctrees/honeybee_ies.reader.doctree
diff --git a/docs/.doctrees/honeybee_ies.templates.doctree b/docs/.doctrees/honeybee_ies.templates.doctree
diff --git a/docs/.doctrees/honeybee_ies.writer.doctree b/docs/.doctrees/honeybee_ies.writer.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+# documentation
diff --git a/docs/_modules/honeybee_ies/reader.html b/docs/_modules/honeybee_ies/reader.html
diff --git a/docs/_modules/honeybee_ies/writer.html b/docs/_modules/honeybee_ies/writer.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Overview: module code &#8212; honeybee-ies  documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/custom.css" />
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+    <script src="../_static/jquery.js"></script>
+    <script src="../_static/underscore.js"></script>
+    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="../_static/doctools.js"></script>
+    <script src="../_static/sphinx_highlight.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+<meta charset='utf-8'>
+<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
+<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
+<meta name="apple-mobile-web-app-capable" content="yes">
+<script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js "></script>
+<script type="text/javascript" src="../_static/js/jquery-fix.js "></script>
+<script type="text/javascript" src="../_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
+<script type="text/javascript" src="../_static/bootstrap-sphinx.js "></script>
+
+  </head><body>
+
+  <div id="navbar" class="navbar navbar-inverse navbar-default navbar-fixed-top">
+    <div class="container">
+      <div class="navbar-header">
+        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="../index.html">
+          honeybee-ies</a>
+        <span class="navbar-text navbar-version pull-left"><b></b></span>
+      </div>
+
+        <div class="collapse navbar-collapse nav-collapse">
+          <ul class="nav navbar-nav">
+
+
+              <li class="dropdown globaltoc-container">
+  <a role="button"
+     id="dLabelGlobalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="../index.html">Site <b class="caret"></b></a>
+  <ul class="dropdown-menu globaltoc"
+      role="menu"
+      aria-labelledby="dLabelGlobalToc"><ul>
+<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">CLI Docs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../cli/index.html#installation">Installation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../cli/index.html#commands">Commands</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../cli/translate.html">translate</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../cli/translate.html#honeybee-ies-translate">honeybee-ies translate</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../cli/translate.html#honeybee-ies-translate-gem-to-model">gem-to-model</a></li>
+<li class="toctree-l5"><a class="reference internal" href="../cli/translate.html#honeybee-ies-translate-model-to-gem">model-to-gem</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../honeybee_ies.html">honeybee_ies package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="../honeybee_ies.html#subpackages">Subpackages</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../honeybee_ies.cli.html">honeybee_ies.cli package</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../honeybee_ies.cli.html#submodules">Submodules</a><ul>
+<li class="toctree-l5"><a class="reference internal" href="../honeybee_ies.cli.translate.html">honeybee_ies.cli.translate module</a></li>
+</ul>
+</li>
+<li class="toctree-l4"><a class="reference internal" href="../honeybee_ies.cli.html#module-honeybee_ies.cli">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../honeybee_ies.html#submodules">Submodules</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="../honeybee_ies.reader.html">honeybee_ies.reader module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../honeybee_ies.reader.html#honeybee_ies.reader.model_from_ies"><code class="docutils literal notranslate"><span class="pre">model_from_ies()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="../honeybee_ies.templates.html">honeybee_ies.templates module</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../honeybee_ies.writer.html">honeybee_ies.writer module</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="../honeybee_ies.writer.html#honeybee_ies.writer.model_to_ies"><code class="docutils literal notranslate"><span class="pre">model_to_ies()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="../honeybee_ies.writer.html#honeybee_ies.writer.room_to_ies"><code class="docutils literal notranslate"><span class="pre">room_to_ies()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="../honeybee_ies.writer.html#honeybee_ies.writer.shades_to_ies"><code class="docutils literal notranslate"><span class="pre">shades_to_ies()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="../honeybee_ies.html#module-honeybee_ies">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</ul>
+</li>
+
+                <li class="dropdown">
+  <a role="button"
+     id="dLabelLocalToc"
+     data-toggle="dropdown"
+     data-target="#"
+     href="#">Page <b class="caret"></b></a>
+  <ul class="dropdown-menu localtoc"
+      role="menu"
+      aria-labelledby="dLabelLocalToc"><ul>
+<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">CLI Docs</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../honeybee_ies.html">honeybee_ies package</a></li>
+</ul>
+</ul>
+</li>
+
+
+
+
+
+
+
+
+
+
+              <li class="hidden-sm"></li>
+
+          </ul>
+
+
+
+<form class="navbar-form navbar-right" action="../search.html" method="get">
+ <div class="form-group">
+  <input type="text" name="q" class="form-control" placeholder="Search" />
+ </div>
+  <input type="hidden" name="check_keywords" value="yes" />
+  <input type="hidden" name="area" value="default" />
+</form>
+
+        </div>
+    </div>
+  </div>
+
+<div class="container">
+  <div class="row">
+      <div class="col-md-4">
+        <div id="sidebar" class="bs-sidenav" role="complementary"><ul>
+<li class="toctree-l1"><a class="reference internal" href="../cli/index.html">CLI Docs</a></li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../honeybee_ies.html">honeybee_ies package</a></li>
+</ul>
+
+        </div>
+      </div>
+    <div class="body col-md-8 content" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="honeybee_ies/reader.html">honeybee_ies.reader</a></li>
+<li><a href="honeybee_ies/writer.html">honeybee_ies.writer</a></li>
+</ul>
+
+    </div>
+
+  </div>
+</div>
+<footer class="footer">
+  <div class="container">
+    <p class="pull-right">
+      <a href="#">Back to top</a>
+
+    </p>
+    <p>
+        &copy; Copyright 2023, Ladybug Tools.<br/>
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br/>
+    </p>
+  </div>
+</footer>
+  </body>
+</html>
diff --git a/docs/_sources/cli/index.rst.txt b/docs/_sources/cli/index.rst.txt
@@ -0,0 +1,15 @@
+CLI Docs
+========
+
+Installation
+------------
+
+To check if the command line is installed correctly use ``honeybee-ies --help``
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   __init__
+   translate
diff --git a/docs/_sources/cli/main.rst.txt b/docs/_sources/cli/main.rst.txt
@@ -0,0 +1,7 @@
+main
+====
+
+.. click:: honeybee_ies.cli.__init__:ies
+   :prog: honeybee-ies
+   :show-nested:
+   :commands: 
diff --git a/docs/_sources/cli/translate.rst.txt b/docs/_sources/cli/translate.rst.txt
@@ -0,0 +1,6 @@
+translate
+=========
+
+.. click:: honeybee_ies.cli.translate:translate
+   :prog: honeybee-ies translate
+   :show-nested:
diff --git a/docs/_sources/honeybee_ies.cli.rst.txt b/docs/_sources/honeybee_ies.cli.rst.txt
@@ -0,0 +1,18 @@
+honeybee\_ies.cli package
+=========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_ies.cli.translate
+
+Module contents
+---------------
+
+.. automodule:: honeybee_ies.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_ies.cli.translate.rst.txt b/docs/_sources/honeybee_ies.cli.translate.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_ies.cli.translate module
+==================================
+
+.. automodule:: honeybee_ies.cli.translate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_ies.reader.rst.txt b/docs/_sources/honeybee_ies.reader.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_ies.reader module
+===========================
+
+.. automodule:: honeybee_ies.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_ies.rst.txt b/docs/_sources/honeybee_ies.rst.txt
@@ -0,0 +1,28 @@
+honeybee\_ies package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_ies.cli
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_ies.reader
+   honeybee_ies.templates
+   honeybee_ies.writer
+
+Module contents
+---------------
+
+.. automodule:: honeybee_ies
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_ies.templates.rst.txt b/docs/_sources/honeybee_ies.templates.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_ies.templates module
+==============================
+
+.. automodule:: honeybee_ies.templates
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_ies.writer.rst.txt b/docs/_sources/honeybee_ies.writer.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_ies.writer module
+===========================
+
+.. automodule:: honeybee_ies.writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,39 @@
+Welcome to honeybee-ies's documentation!
+===================================
+
+Honeybee extension for import and export to/from IES-VE
+
+
+Installation
+============
+
+``pip install honeybee-ies``
+
+
+honeybee-ies
+=======
+
+CLI Docs
+========
+
+For command line interface documentation and API documentation see the pages below.
+
+.. toctree::
+   :maxdepth: 2
+
+   cli//index
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+.. include:: modules.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+honeybee_ies
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_ies