deploy: update docs

ladybug-tools · Sep 18, 2024 · a1d37ce · a1d37ce
commit a1d37ce
Show file tree

Hide file tree

Showing 213 changed files with 126,988 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: 89d4175636d7a8278efe82e967435b14
+tags: 645f666f9bcd5a90fca523b33c5a78b7
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/translate.doctree b/docs/.doctrees/cli/translate.doctree
diff --git a/docs/.doctrees/cli/validate.doctree b/docs/.doctrees/cli/validate.doctree
diff --git a/docs/.doctrees/dragonfly.building.doctree b/docs/.doctrees/dragonfly.building.doctree
diff --git a/docs/.doctrees/dragonfly.cli.create.doctree b/docs/.doctrees/dragonfly.cli.create.doctree
diff --git a/docs/.doctrees/dragonfly.cli.doctree b/docs/.doctrees/dragonfly.cli.doctree
diff --git a/docs/.doctrees/dragonfly.cli.edit.doctree b/docs/.doctrees/dragonfly.cli.edit.doctree
diff --git a/docs/.doctrees/dragonfly.cli.translate.doctree b/docs/.doctrees/dragonfly.cli.translate.doctree
diff --git a/docs/.doctrees/dragonfly.cli.validate.doctree b/docs/.doctrees/dragonfly.cli.validate.doctree
diff --git a/docs/.doctrees/dragonfly.colorobj.doctree b/docs/.doctrees/dragonfly.colorobj.doctree
diff --git a/docs/.doctrees/dragonfly.config.doctree b/docs/.doctrees/dragonfly.config.doctree
diff --git a/docs/.doctrees/dragonfly.context.doctree b/docs/.doctrees/dragonfly.context.doctree
diff --git a/docs/.doctrees/dragonfly.dictutil.doctree b/docs/.doctrees/dragonfly.dictutil.doctree
diff --git a/docs/.doctrees/dragonfly.doctree b/docs/.doctrees/dragonfly.doctree
diff --git a/docs/.doctrees/dragonfly.extensionutil.doctree b/docs/.doctrees/dragonfly.extensionutil.doctree
diff --git a/docs/.doctrees/dragonfly.model.doctree b/docs/.doctrees/dragonfly.model.doctree
diff --git a/docs/.doctrees/dragonfly.projection.doctree b/docs/.doctrees/dragonfly.projection.doctree
diff --git a/docs/.doctrees/dragonfly.properties.doctree b/docs/.doctrees/dragonfly.properties.doctree
diff --git a/docs/.doctrees/dragonfly.roof.doctree b/docs/.doctrees/dragonfly.roof.doctree
diff --git a/docs/.doctrees/dragonfly.room2d.doctree b/docs/.doctrees/dragonfly.room2d.doctree
diff --git a/docs/.doctrees/dragonfly.shadingparameter.doctree b/docs/.doctrees/dragonfly.shadingparameter.doctree
diff --git a/docs/.doctrees/dragonfly.skylightparameter.doctree b/docs/.doctrees/dragonfly.skylightparameter.doctree
diff --git a/docs/.doctrees/dragonfly.story.doctree b/docs/.doctrees/dragonfly.story.doctree
diff --git a/docs/.doctrees/dragonfly.subdivide.doctree b/docs/.doctrees/dragonfly.subdivide.doctree
diff --git a/docs/.doctrees/dragonfly.windowparameter.doctree b/docs/.doctrees/dragonfly.windowparameter.doctree
diff --git a/docs/.doctrees/dragonfly.writer.building.doctree b/docs/.doctrees/dragonfly.writer.building.doctree
diff --git a/docs/.doctrees/dragonfly.writer.context.doctree b/docs/.doctrees/dragonfly.writer.context.doctree
diff --git a/docs/.doctrees/dragonfly.writer.doctree b/docs/.doctrees/dragonfly.writer.doctree
diff --git a/docs/.doctrees/dragonfly.writer.model.doctree b/docs/.doctrees/dragonfly.writer.model.doctree
diff --git a/docs/.doctrees/dragonfly.writer.room2d.doctree b/docs/.doctrees/dragonfly.writer.room2d.doctree
diff --git a/docs/.doctrees/dragonfly.writer.story.doctree b/docs/.doctrees/dragonfly.writer.story.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
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/dragonfly/building.html b/docs/_modules/dragonfly/building.html
diff --git a/docs/_modules/dragonfly/colorobj.html b/docs/_modules/dragonfly/colorobj.html
diff --git a/docs/_modules/dragonfly/config.html b/docs/_modules/dragonfly/config.html
diff --git a/docs/_modules/dragonfly/context.html b/docs/_modules/dragonfly/context.html
diff --git a/docs/_modules/dragonfly/dictutil.html b/docs/_modules/dragonfly/dictutil.html
diff --git a/docs/_modules/dragonfly/extensionutil.html b/docs/_modules/dragonfly/extensionutil.html
diff --git a/docs/_modules/dragonfly/model.html b/docs/_modules/dragonfly/model.html
diff --git a/docs/_modules/dragonfly/projection.html b/docs/_modules/dragonfly/projection.html
diff --git a/docs/_modules/dragonfly/properties.html b/docs/_modules/dragonfly/properties.html
diff --git a/docs/_modules/dragonfly/roof.html b/docs/_modules/dragonfly/roof.html
diff --git a/docs/_modules/dragonfly/room2d.html b/docs/_modules/dragonfly/room2d.html
diff --git a/docs/_modules/dragonfly/shadingparameter.html b/docs/_modules/dragonfly/shadingparameter.html
diff --git a/docs/_modules/dragonfly/skylightparameter.html b/docs/_modules/dragonfly/skylightparameter.html
diff --git a/docs/_modules/dragonfly/story.html b/docs/_modules/dragonfly/story.html
diff --git a/docs/_modules/dragonfly/subdivide.html b/docs/_modules/dragonfly/subdivide.html
diff --git a/docs/_modules/dragonfly/windowparameter.html b/docs/_modules/dragonfly/windowparameter.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
diff --git a/docs/_sources/cli/create.rst.txt b/docs/_sources/cli/create.rst.txt
@@ -0,0 +1,6 @@
+create
+======
+
+.. click:: dragonfly.cli.create:create
+ :prog: dragonfly 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:: dragonfly.cli.edit:edit
+ :prog: dragonfly edit
+ :show-nested:
diff --git a/docs/_sources/cli/index.rst.txt b/docs/_sources/cli/index.rst.txt
@@ -0,0 +1,18 @@
+CLI Docs
+========
+
+Installation
+------------
+
+To check if the Dragonfly command line interface is installed correctly use ``dragonfly viz`` and you
+should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!
+
+Commands
+--------
+.. toctree::
+ :maxdepth: 1
+
+ edit
+ validate
+ create
+ translate
diff --git a/docs/_sources/cli/translate.rst.txt b/docs/_sources/cli/translate.rst.txt
@@ -0,0 +1,6 @@
+translate
+=========
+
+.. click:: dragonfly.cli.translate:translate
+ :prog: dragonfly translate
+ :show-nested:
diff --git a/docs/_sources/cli/validate.rst.txt b/docs/_sources/cli/validate.rst.txt
@@ -0,0 +1,6 @@
+validate
+========
+
+.. click:: dragonfly.cli.validate:validate
+ :prog: dragonfly validate
+ :show-nested:
diff --git a/docs/_sources/dragonfly.building.rst.txt b/docs/_sources/dragonfly.building.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.building module
+=========================
+
+.. automodule:: dragonfly.building
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.cli.create.rst.txt b/docs/_sources/dragonfly.cli.create.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.cli.create module
+===========================
+
+.. automodule:: dragonfly.cli.create
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.cli.edit.rst.txt b/docs/_sources/dragonfly.cli.edit.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.cli.edit module
+=========================
+
+.. automodule:: dragonfly.cli.edit
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.cli.rst.txt b/docs/_sources/dragonfly.cli.rst.txt
@@ -0,0 +1,21 @@
+dragonfly.cli package
+=====================
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ dragonfly.cli.create
+ dragonfly.cli.edit
+ dragonfly.cli.translate
+ dragonfly.cli.validate
+
+Module contents
+---------------
+
+.. automodule:: dragonfly.cli
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.cli.translate.rst.txt b/docs/_sources/dragonfly.cli.translate.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.cli.translate module
+==============================
+
+.. automodule:: dragonfly.cli.translate
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.cli.validate.rst.txt b/docs/_sources/dragonfly.cli.validate.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.cli.validate module
+=============================
+
+.. automodule:: dragonfly.cli.validate
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.colorobj.rst.txt b/docs/_sources/dragonfly.colorobj.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.colorobj module
+=========================
+
+.. automodule:: dragonfly.colorobj
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.config.rst.txt b/docs/_sources/dragonfly.config.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.config module
+=======================
+
+.. automodule:: dragonfly.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.context.rst.txt b/docs/_sources/dragonfly.context.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.context module
+========================
+
+.. automodule:: dragonfly.context
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.dictutil.rst.txt b/docs/_sources/dragonfly.dictutil.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.dictutil module
+=========================
+
+.. automodule:: dragonfly.dictutil
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.extensionutil.rst.txt b/docs/_sources/dragonfly.extensionutil.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.extensionutil module
+==============================
+
+.. automodule:: dragonfly.extensionutil
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.model.rst.txt b/docs/_sources/dragonfly.model.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.model module
+======================
+
+.. automodule:: dragonfly.model
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.projection.rst.txt b/docs/_sources/dragonfly.projection.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.projection module
+===========================
+
+.. automodule:: dragonfly.projection
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.properties.rst.txt b/docs/_sources/dragonfly.properties.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.properties module
+===========================
+
+.. automodule:: dragonfly.properties
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.roof.rst.txt b/docs/_sources/dragonfly.roof.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.roof module
+=====================
+
+.. automodule:: dragonfly.roof
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.room2d.rst.txt b/docs/_sources/dragonfly.room2d.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.room2d module
+=======================
+
+.. automodule:: dragonfly.room2d
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.rst.txt b/docs/_sources/dragonfly.rst.txt
@@ -0,0 +1,42 @@
+dragonfly package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ dragonfly.cli
+ dragonfly.writer
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ dragonfly.building
+ dragonfly.colorobj
+ dragonfly.config
+ dragonfly.context
+ dragonfly.dictutil
+ dragonfly.extensionutil
+ dragonfly.model
+ dragonfly.projection
+ dragonfly.properties
+ dragonfly.roof
+ dragonfly.room2d
+ dragonfly.shadingparameter
+ dragonfly.skylightparameter
+ dragonfly.story
+ dragonfly.subdivide
+ dragonfly.windowparameter
+
+Module contents
+---------------
+
+.. automodule:: dragonfly
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.shadingparameter.rst.txt b/docs/_sources/dragonfly.shadingparameter.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.shadingparameter module
+=================================
+
+.. automodule:: dragonfly.shadingparameter
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.skylightparameter.rst.txt b/docs/_sources/dragonfly.skylightparameter.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.skylightparameter module
+==================================
+
+.. automodule:: dragonfly.skylightparameter
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.story.rst.txt b/docs/_sources/dragonfly.story.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.story module
+======================
+
+.. automodule:: dragonfly.story
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.subdivide.rst.txt b/docs/_sources/dragonfly.subdivide.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.subdivide module
+==========================
+
+.. automodule:: dragonfly.subdivide
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.windowparameter.rst.txt b/docs/_sources/dragonfly.windowparameter.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.windowparameter module
+================================
+
+.. automodule:: dragonfly.windowparameter
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.writer.building.rst.txt b/docs/_sources/dragonfly.writer.building.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.writer.building module
+================================
+
+.. automodule:: dragonfly.writer.building
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.writer.context.rst.txt b/docs/_sources/dragonfly.writer.context.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.writer.context module
+===============================
+
+.. automodule:: dragonfly.writer.context
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.writer.model.rst.txt b/docs/_sources/dragonfly.writer.model.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.writer.model module
+=============================
+
+.. automodule:: dragonfly.writer.model
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.writer.room2d.rst.txt b/docs/_sources/dragonfly.writer.room2d.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.writer.room2d module
+==============================
+
+.. automodule:: dragonfly.writer.room2d
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.writer.rst.txt b/docs/_sources/dragonfly.writer.rst.txt
@@ -0,0 +1,22 @@
+dragonfly.writer package
+========================
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ dragonfly.writer.building
+ dragonfly.writer.context
+ dragonfly.writer.model
+ dragonfly.writer.room2d
+ dragonfly.writer.story
+
+Module contents
+---------------
+
+.. automodule:: dragonfly.writer
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_sources/dragonfly.writer.story.rst.txt b/docs/_sources/dragonfly.writer.story.rst.txt
@@ -0,0 +1,7 @@
+dragonfly.writer.story module
+=============================
+
+.. automodule:: dragonfly.writer.story
+ :members:
+ :undoc-members:
+ :show-inheritance: