deploy: update docs

ladybug-tools · Oct 16, 2024 · 320d88f · 320d88f
commit 320d88f
Show file tree

Hide file tree

Showing 155 changed files with 41,704 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
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: 6d1deba435e026ed761fa0e0dbeffa98
+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_doe2.cli.doctree b/docs/.doctrees/honeybee_doe2.cli.doctree
diff --git a/docs/.doctrees/honeybee_doe2.cli.translate.doctree b/docs/.doctrees/honeybee_doe2.cli.translate.doctree
diff --git a/docs/.doctrees/honeybee_doe2.config.doctree b/docs/.doctrees/honeybee_doe2.config.doctree
diff --git a/docs/.doctrees/honeybee_doe2.construction.doctree b/docs/.doctrees/honeybee_doe2.construction.doctree
diff --git a/docs/.doctrees/honeybee_doe2.doctree b/docs/.doctrees/honeybee_doe2.doctree
diff --git a/docs/.doctrees/honeybee_doe2.grouping.doctree b/docs/.doctrees/honeybee_doe2.grouping.doctree
diff --git a/docs/.doctrees/honeybee_doe2.load.doctree b/docs/.doctrees/honeybee_doe2.load.doctree
diff --git a/docs/.doctrees/honeybee_doe2.programtype.doctree b/docs/.doctrees/honeybee_doe2.programtype.doctree
diff --git a/docs/.doctrees/honeybee_doe2.properties.doctree b/docs/.doctrees/honeybee_doe2.properties.doctree
diff --git a/docs/.doctrees/honeybee_doe2.properties.model.doctree b/docs/.doctrees/honeybee_doe2.properties.model.doctree
diff --git a/docs/.doctrees/honeybee_doe2.properties.room.doctree b/docs/.doctrees/honeybee_doe2.properties.room.doctree
diff --git a/docs/.doctrees/honeybee_doe2.schedule.doctree b/docs/.doctrees/honeybee_doe2.schedule.doctree
diff --git a/docs/.doctrees/honeybee_doe2.simulation.doctree b/docs/.doctrees/honeybee_doe2.simulation.doctree
diff --git a/docs/.doctrees/honeybee_doe2.util.doctree b/docs/.doctrees/honeybee_doe2.util.doctree
diff --git a/docs/.doctrees/honeybee_doe2.writer.doctree b/docs/.doctrees/honeybee_doe2.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/_modules/honeybee_doe2/construction.html b/docs/_modules/honeybee_doe2/construction.html
diff --git a/docs/_modules/honeybee_doe2/grouping.html b/docs/_modules/honeybee_doe2/grouping.html
diff --git a/docs/_modules/honeybee_doe2/load.html b/docs/_modules/honeybee_doe2/load.html
diff --git a/docs/_modules/honeybee_doe2/programtype.html b/docs/_modules/honeybee_doe2/programtype.html
diff --git a/docs/_modules/honeybee_doe2/properties/model.html b/docs/_modules/honeybee_doe2/properties/model.html
diff --git a/docs/_modules/honeybee_doe2/properties/room.html b/docs/_modules/honeybee_doe2/properties/room.html
diff --git a/docs/_modules/honeybee_doe2/schedule.html b/docs/_modules/honeybee_doe2/schedule.html
diff --git a/docs/_modules/honeybee_doe2/simulation.html b/docs/_modules/honeybee_doe2/simulation.html
diff --git a/docs/_modules/honeybee_doe2/util.html b/docs/_modules/honeybee_doe2/util.html
diff --git a/docs/_modules/honeybee_doe2/writer.html b/docs/_modules/honeybee_doe2/writer.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.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-doe2 --help``
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   translate
+   __init__
diff --git a/docs/_sources/cli/main.rst.txt b/docs/_sources/cli/main.rst.txt
@@ -0,0 +1,7 @@
+main
+====
+
+.. click:: honeybee_doe2.cli.__init__:doe2
+   :prog: honeybee-doe2
+   :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_doe2.cli.translate:translate
+   :prog: honeybee-doe2 translate
+   :show-nested:
diff --git a/docs/_sources/honeybee_doe2.cli.rst.txt b/docs/_sources/honeybee_doe2.cli.rst.txt
@@ -0,0 +1,18 @@
+honeybee\_doe2.cli package
+==========================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_doe2.cli.translate
+
+Module contents
+---------------
+
+.. automodule:: honeybee_doe2.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.cli.translate.rst.txt b/docs/_sources/honeybee_doe2.cli.translate.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.cli.translate module
+===================================
+
+.. automodule:: honeybee_doe2.cli.translate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.config.rst.txt b/docs/_sources/honeybee_doe2.config.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.config module
+============================
+
+.. automodule:: honeybee_doe2.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.construction.rst.txt b/docs/_sources/honeybee_doe2.construction.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.construction module
+==================================
+
+.. automodule:: honeybee_doe2.construction
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.grouping.rst.txt b/docs/_sources/honeybee_doe2.grouping.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.grouping module
+==============================
+
+.. automodule:: honeybee_doe2.grouping
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.load.rst.txt b/docs/_sources/honeybee_doe2.load.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.load module
+==========================
+
+.. automodule:: honeybee_doe2.load
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.programtype.rst.txt b/docs/_sources/honeybee_doe2.programtype.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.programtype module
+=================================
+
+.. automodule:: honeybee_doe2.programtype
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.properties.model.rst.txt b/docs/_sources/honeybee_doe2.properties.model.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.properties.model module
+======================================
+
+.. automodule:: honeybee_doe2.properties.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.properties.room.rst.txt b/docs/_sources/honeybee_doe2.properties.room.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.properties.room module
+=====================================
+
+.. automodule:: honeybee_doe2.properties.room
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.properties.rst.txt b/docs/_sources/honeybee_doe2.properties.rst.txt
@@ -0,0 +1,19 @@
+honeybee\_doe2.properties package
+=================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_doe2.properties.model
+   honeybee_doe2.properties.room
+
+Module contents
+---------------
+
+.. automodule:: honeybee_doe2.properties
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.rst.txt b/docs/_sources/honeybee_doe2.rst.txt
@@ -0,0 +1,35 @@
+honeybee\_doe2 package
+======================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_doe2.cli
+   honeybee_doe2.properties
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_doe2.config
+   honeybee_doe2.construction
+   honeybee_doe2.grouping
+   honeybee_doe2.load
+   honeybee_doe2.programtype
+   honeybee_doe2.schedule
+   honeybee_doe2.simulation
+   honeybee_doe2.util
+   honeybee_doe2.writer
+
+Module contents
+---------------
+
+.. automodule:: honeybee_doe2
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.schedule.rst.txt b/docs/_sources/honeybee_doe2.schedule.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.schedule module
+==============================
+
+.. automodule:: honeybee_doe2.schedule
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.simulation.rst.txt b/docs/_sources/honeybee_doe2.simulation.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.simulation module
+================================
+
+.. automodule:: honeybee_doe2.simulation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.util.rst.txt b/docs/_sources/honeybee_doe2.util.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.util module
+==========================
+
+.. automodule:: honeybee_doe2.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee_doe2.writer.rst.txt b/docs/_sources/honeybee_doe2.writer.rst.txt
@@ -0,0 +1,7 @@
+honeybee\_doe2.writer module
+============================
+
+.. automodule:: honeybee_doe2.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-doe2's documentation!
+===================================
+
+Honeybee extension for import and export to/from IES-VE
+
+
+Installation
+============
+
+``pip install honeybee-doe2``
+
+
+honeybee-doe2
+=======
+
+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_doe2
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee_doe2