deploy: update docs

ladybug-tools · Dec 9, 2024 · fef5850 · fef5850
commit fef5850
Show file tree

Hide file tree

Showing 250 changed files with 145,137 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
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: b1b6b77ea7804bab1ee268c44f50ae98
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/cli/compare.doctree b/docs/.doctrees/cli/compare.doctree
diff --git a/docs/.doctrees/cli/create.doctree b/docs/.doctrees/cli/create.doctree
diff --git a/docs/.doctrees/cli/edit.doctree b/docs/.doctrees/cli/edit.doctree
diff --git a/docs/.doctrees/cli/index.doctree b/docs/.doctrees/cli/index.doctree
diff --git a/docs/.doctrees/cli/lib.doctree b/docs/.doctrees/cli/lib.doctree
diff --git a/docs/.doctrees/cli/main.doctree b/docs/.doctrees/cli/main.doctree
diff --git a/docs/.doctrees/cli/setconfig.doctree b/docs/.doctrees/cli/setconfig.doctree
diff --git a/docs/.doctrees/cli/validate.doctree b/docs/.doctrees/cli/validate.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/honeybee.altnumber.doctree b/docs/.doctrees/honeybee.altnumber.doctree
diff --git a/docs/.doctrees/honeybee.aperture.doctree b/docs/.doctrees/honeybee.aperture.doctree
diff --git a/docs/.doctrees/honeybee.boundarycondition.doctree b/docs/.doctrees/honeybee.boundarycondition.doctree
diff --git a/docs/.doctrees/honeybee.checkdup.doctree b/docs/.doctrees/honeybee.checkdup.doctree
diff --git a/docs/.doctrees/honeybee.cli.compare.doctree b/docs/.doctrees/honeybee.cli.compare.doctree
diff --git a/docs/.doctrees/honeybee.cli.create.doctree b/docs/.doctrees/honeybee.cli.create.doctree
diff --git a/docs/.doctrees/honeybee.cli.doctree b/docs/.doctrees/honeybee.cli.doctree
diff --git a/docs/.doctrees/honeybee.cli.edit.doctree b/docs/.doctrees/honeybee.cli.edit.doctree
diff --git a/docs/.doctrees/honeybee.cli.lib.doctree b/docs/.doctrees/honeybee.cli.lib.doctree
diff --git a/docs/.doctrees/honeybee.cli.setconfig.doctree b/docs/.doctrees/honeybee.cli.setconfig.doctree
diff --git a/docs/.doctrees/honeybee.cli.validate.doctree b/docs/.doctrees/honeybee.cli.validate.doctree
diff --git a/docs/.doctrees/honeybee.colorobj.doctree b/docs/.doctrees/honeybee.colorobj.doctree
diff --git a/docs/.doctrees/honeybee.config.doctree b/docs/.doctrees/honeybee.config.doctree
diff --git a/docs/.doctrees/honeybee.dictutil.doctree b/docs/.doctrees/honeybee.dictutil.doctree
diff --git a/docs/.doctrees/honeybee.doctree b/docs/.doctrees/honeybee.doctree
diff --git a/docs/.doctrees/honeybee.door.doctree b/docs/.doctrees/honeybee.door.doctree
diff --git a/docs/.doctrees/honeybee.extensionutil.doctree b/docs/.doctrees/honeybee.extensionutil.doctree
diff --git a/docs/.doctrees/honeybee.face.doctree b/docs/.doctrees/honeybee.face.doctree
diff --git a/docs/.doctrees/honeybee.facetype.doctree b/docs/.doctrees/honeybee.facetype.doctree
diff --git a/docs/.doctrees/honeybee.logutil.doctree b/docs/.doctrees/honeybee.logutil.doctree
diff --git a/docs/.doctrees/honeybee.model.doctree b/docs/.doctrees/honeybee.model.doctree
diff --git a/docs/.doctrees/honeybee.orientation.doctree b/docs/.doctrees/honeybee.orientation.doctree
diff --git a/docs/.doctrees/honeybee.properties.doctree b/docs/.doctrees/honeybee.properties.doctree
diff --git a/docs/.doctrees/honeybee.room.doctree b/docs/.doctrees/honeybee.room.doctree
diff --git a/docs/.doctrees/honeybee.search.doctree b/docs/.doctrees/honeybee.search.doctree
diff --git a/docs/.doctrees/honeybee.shade.doctree b/docs/.doctrees/honeybee.shade.doctree
diff --git a/docs/.doctrees/honeybee.shademesh.doctree b/docs/.doctrees/honeybee.shademesh.doctree
diff --git a/docs/.doctrees/honeybee.typing.doctree b/docs/.doctrees/honeybee.typing.doctree
diff --git a/docs/.doctrees/honeybee.units.doctree b/docs/.doctrees/honeybee.units.doctree
diff --git a/docs/.doctrees/honeybee.writer.aperture.doctree b/docs/.doctrees/honeybee.writer.aperture.doctree
diff --git a/docs/.doctrees/honeybee.writer.doctree b/docs/.doctrees/honeybee.writer.doctree
diff --git a/docs/.doctrees/honeybee.writer.door.doctree b/docs/.doctrees/honeybee.writer.door.doctree
diff --git a/docs/.doctrees/honeybee.writer.face.doctree b/docs/.doctrees/honeybee.writer.face.doctree
diff --git a/docs/.doctrees/honeybee.writer.model.doctree b/docs/.doctrees/honeybee.writer.model.doctree
diff --git a/docs/.doctrees/honeybee.writer.room.doctree b/docs/.doctrees/honeybee.writer.room.doctree
diff --git a/docs/.doctrees/honeybee.writer.shade.doctree b/docs/.doctrees/honeybee.writer.shade.doctree
diff --git a/docs/.doctrees/honeybee.writer.shademesh.doctree b/docs/.doctrees/honeybee.writer.shademesh.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/altnumber.html b/docs/_modules/honeybee/altnumber.html
diff --git a/docs/_modules/honeybee/aperture.html b/docs/_modules/honeybee/aperture.html
diff --git a/docs/_modules/honeybee/boundarycondition.html b/docs/_modules/honeybee/boundarycondition.html
diff --git a/docs/_modules/honeybee/checkdup.html b/docs/_modules/honeybee/checkdup.html
diff --git a/docs/_modules/honeybee/cli/validate.html b/docs/_modules/honeybee/cli/validate.html
diff --git a/docs/_modules/honeybee/colorobj.html b/docs/_modules/honeybee/colorobj.html
diff --git a/docs/_modules/honeybee/config.html b/docs/_modules/honeybee/config.html
diff --git a/docs/_modules/honeybee/dictutil.html b/docs/_modules/honeybee/dictutil.html
diff --git a/docs/_modules/honeybee/door.html b/docs/_modules/honeybee/door.html
diff --git a/docs/_modules/honeybee/extensionutil.html b/docs/_modules/honeybee/extensionutil.html
diff --git a/docs/_modules/honeybee/face.html b/docs/_modules/honeybee/face.html
diff --git a/docs/_modules/honeybee/facetype.html b/docs/_modules/honeybee/facetype.html
diff --git a/docs/_modules/honeybee/logutil.html b/docs/_modules/honeybee/logutil.html
diff --git a/docs/_modules/honeybee/model.html b/docs/_modules/honeybee/model.html
diff --git a/docs/_modules/honeybee/orientation.html b/docs/_modules/honeybee/orientation.html
diff --git a/docs/_modules/honeybee/properties.html b/docs/_modules/honeybee/properties.html
diff --git a/docs/_modules/honeybee/room.html b/docs/_modules/honeybee/room.html
diff --git a/docs/_modules/honeybee/search.html b/docs/_modules/honeybee/search.html
diff --git a/docs/_modules/honeybee/shade.html b/docs/_modules/honeybee/shade.html
diff --git a/docs/_modules/honeybee/shademesh.html b/docs/_modules/honeybee/shademesh.html
diff --git a/docs/_modules/honeybee/typing.html b/docs/_modules/honeybee/typing.html
diff --git a/docs/_modules/honeybee/units.html b/docs/_modules/honeybee/units.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
diff --git a/docs/_sources/cli/compare.rst.txt b/docs/_sources/cli/compare.rst.txt
@@ -0,0 +1,6 @@
+compare
+=======
+
+.. click:: honeybee.cli.compare:compare
+   :prog: honeybee compare
+   :show-nested:
diff --git a/docs/_sources/cli/create.rst.txt b/docs/_sources/cli/create.rst.txt
@@ -0,0 +1,6 @@
+create
+======
+
+.. click:: honeybee.cli.create:create
+   :prog: honeybee create
+   :show-nested:
diff --git a/docs/_sources/cli/edit.rst.txt b/docs/_sources/cli/edit.rst.txt
@@ -0,0 +1,6 @@
+edit
+====
+
+.. click:: honeybee.cli.edit:edit
+   :prog: honeybee edit
+   :show-nested:
diff --git a/docs/_sources/cli/index.rst.txt b/docs/_sources/cli/index.rst.txt
@@ -0,0 +1,21 @@
+CLI Docs
+========
+
+Installation
+------------
+
+To check if the Honeybee command line interface is installed correctly try ``honeybee viz`` and you
+should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   main
+   compare
+   setconfig
+   lib
+   edit
+   validate
+   create
diff --git a/docs/_sources/cli/lib.rst.txt b/docs/_sources/cli/lib.rst.txt
@@ -0,0 +1,6 @@
+lib
+===
+
+.. click:: honeybee.cli.lib:lib
+   :prog: honeybee lib
+   :show-nested:
diff --git a/docs/_sources/cli/main.rst.txt b/docs/_sources/cli/main.rst.txt
@@ -0,0 +1,7 @@
+main
+====
+
+.. click:: honeybee.cli.__init__:main
+   :prog: honeybee
+   :show-nested:
+   :commands: config ,viz
diff --git a/docs/_sources/cli/setconfig.rst.txt b/docs/_sources/cli/setconfig.rst.txt
@@ -0,0 +1,6 @@
+setconfig
+=========
+
+.. click:: honeybee.cli.setconfig:set_config
+   :prog: honeybee set-config
+   :show-nested:
diff --git a/docs/_sources/cli/validate.rst.txt b/docs/_sources/cli/validate.rst.txt
@@ -0,0 +1,6 @@
+validate
+========
+
+.. click:: honeybee.cli.validate:validate
+   :prog: honeybee validate
+   :show-nested:
diff --git a/docs/_sources/honeybee.altnumber.rst.txt b/docs/_sources/honeybee.altnumber.rst.txt
@@ -0,0 +1,7 @@
+honeybee.altnumber module
+=========================
+
+.. automodule:: honeybee.altnumber
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.aperture.rst.txt b/docs/_sources/honeybee.aperture.rst.txt
@@ -0,0 +1,7 @@
+honeybee.aperture module
+========================
+
+.. automodule:: honeybee.aperture
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.boundarycondition.rst.txt b/docs/_sources/honeybee.boundarycondition.rst.txt
@@ -0,0 +1,7 @@
+honeybee.boundarycondition module
+=================================
+
+.. automodule:: honeybee.boundarycondition
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.checkdup.rst.txt b/docs/_sources/honeybee.checkdup.rst.txt
@@ -0,0 +1,7 @@
+honeybee.checkdup module
+========================
+
+.. automodule:: honeybee.checkdup
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.compare.rst.txt b/docs/_sources/honeybee.cli.compare.rst.txt
@@ -0,0 +1,7 @@
+honeybee.cli.compare module
+===========================
+
+.. automodule:: honeybee.cli.compare
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.create.rst.txt b/docs/_sources/honeybee.cli.create.rst.txt
@@ -0,0 +1,7 @@
+honeybee.cli.create module
+==========================
+
+.. automodule:: honeybee.cli.create
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.edit.rst.txt b/docs/_sources/honeybee.cli.edit.rst.txt
@@ -0,0 +1,7 @@
+honeybee.cli.edit module
+========================
+
+.. automodule:: honeybee.cli.edit
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.lib.rst.txt b/docs/_sources/honeybee.cli.lib.rst.txt
@@ -0,0 +1,7 @@
+honeybee.cli.lib module
+=======================
+
+.. automodule:: honeybee.cli.lib
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.rst.txt b/docs/_sources/honeybee.cli.rst.txt
@@ -0,0 +1,23 @@
+honeybee.cli package
+====================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee.cli.compare
+   honeybee.cli.create
+   honeybee.cli.edit
+   honeybee.cli.lib
+   honeybee.cli.setconfig
+   honeybee.cli.validate
+
+Module contents
+---------------
+
+.. automodule:: honeybee.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.setconfig.rst.txt b/docs/_sources/honeybee.cli.setconfig.rst.txt
@@ -0,0 +1,7 @@
+honeybee.cli.setconfig module
+=============================
+
+.. automodule:: honeybee.cli.setconfig
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.cli.validate.rst.txt b/docs/_sources/honeybee.cli.validate.rst.txt
@@ -0,0 +1,7 @@
+honeybee.cli.validate module
+============================
+
+.. automodule:: honeybee.cli.validate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.colorobj.rst.txt b/docs/_sources/honeybee.colorobj.rst.txt
@@ -0,0 +1,7 @@
+honeybee.colorobj module
+========================
+
+.. automodule:: honeybee.colorobj
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.config.rst.txt b/docs/_sources/honeybee.config.rst.txt
@@ -0,0 +1,7 @@
+honeybee.config module
+======================
+
+.. automodule:: honeybee.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.dictutil.rst.txt b/docs/_sources/honeybee.dictutil.rst.txt
@@ -0,0 +1,7 @@
+honeybee.dictutil module
+========================
+
+.. automodule:: honeybee.dictutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.door.rst.txt b/docs/_sources/honeybee.door.rst.txt
@@ -0,0 +1,7 @@
+honeybee.door module
+====================
+
+.. automodule:: honeybee.door
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.extensionutil.rst.txt b/docs/_sources/honeybee.extensionutil.rst.txt
@@ -0,0 +1,7 @@
+honeybee.extensionutil module
+=============================
+
+.. automodule:: honeybee.extensionutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.face.rst.txt b/docs/_sources/honeybee.face.rst.txt
@@ -0,0 +1,7 @@
+honeybee.face module
+====================
+
+.. automodule:: honeybee.face
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.facetype.rst.txt b/docs/_sources/honeybee.facetype.rst.txt
@@ -0,0 +1,7 @@
+honeybee.facetype module
+========================
+
+.. automodule:: honeybee.facetype
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.logutil.rst.txt b/docs/_sources/honeybee.logutil.rst.txt
@@ -0,0 +1,7 @@
+honeybee.logutil module
+=======================
+
+.. automodule:: honeybee.logutil
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.model.rst.txt b/docs/_sources/honeybee.model.rst.txt
@@ -0,0 +1,7 @@
+honeybee.model module
+=====================
+
+.. automodule:: honeybee.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.orientation.rst.txt b/docs/_sources/honeybee.orientation.rst.txt
@@ -0,0 +1,7 @@
+honeybee.orientation module
+===========================
+
+.. automodule:: honeybee.orientation
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.properties.rst.txt b/docs/_sources/honeybee.properties.rst.txt
@@ -0,0 +1,7 @@
+honeybee.properties module
+==========================
+
+.. automodule:: honeybee.properties
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.room.rst.txt b/docs/_sources/honeybee.room.rst.txt
@@ -0,0 +1,7 @@
+honeybee.room module
+====================
+
+.. automodule:: honeybee.room
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.rst.txt b/docs/_sources/honeybee.rst.txt
@@ -0,0 +1,47 @@
+honeybee package
+================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee.cli
+   honeybee.writer
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   honeybee.altnumber
+   honeybee.aperture
+   honeybee.boundarycondition
+   honeybee.checkdup
+   honeybee.colorobj
+   honeybee.config
+   honeybee.dictutil
+   honeybee.door
+   honeybee.extensionutil
+   honeybee.face
+   honeybee.facetype
+   honeybee.logutil
+   honeybee.model
+   honeybee.orientation
+   honeybee.properties
+   honeybee.room
+   honeybee.search
+   honeybee.shade
+   honeybee.shademesh
+   honeybee.typing
+   honeybee.units
+
+Module contents
+---------------
+
+.. automodule:: honeybee
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.search.rst.txt b/docs/_sources/honeybee.search.rst.txt
@@ -0,0 +1,7 @@
+honeybee.search module
+======================
+
+.. automodule:: honeybee.search
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.shade.rst.txt b/docs/_sources/honeybee.shade.rst.txt
@@ -0,0 +1,7 @@
+honeybee.shade module
+=====================
+
+.. automodule:: honeybee.shade
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.shademesh.rst.txt b/docs/_sources/honeybee.shademesh.rst.txt
@@ -0,0 +1,7 @@
+honeybee.shademesh module
+=========================
+
+.. automodule:: honeybee.shademesh
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.typing.rst.txt b/docs/_sources/honeybee.typing.rst.txt
@@ -0,0 +1,7 @@
+honeybee.typing module
+======================
+
+.. automodule:: honeybee.typing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.units.rst.txt b/docs/_sources/honeybee.units.rst.txt
@@ -0,0 +1,7 @@
+honeybee.units module
+=====================
+
+.. automodule:: honeybee.units
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.writer.aperture.rst.txt b/docs/_sources/honeybee.writer.aperture.rst.txt
@@ -0,0 +1,7 @@
+honeybee.writer.aperture module
+===============================
+
+.. automodule:: honeybee.writer.aperture
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.writer.door.rst.txt b/docs/_sources/honeybee.writer.door.rst.txt
@@ -0,0 +1,7 @@
+honeybee.writer.door module
+===========================
+
+.. automodule:: honeybee.writer.door
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/honeybee.writer.face.rst.txt b/docs/_sources/honeybee.writer.face.rst.txt
@@ -0,0 +1,7 @@
+honeybee.writer.face module
+===========================
+
+.. automodule:: honeybee.writer.face
+   :members:
+   :undoc-members:
+   :show-inheritance: