deploy: update docs

ladybug-tools · Feb 4, 2025 · b018874 · b018874
commit b018874
Show file tree

Hide file tree

Showing 135 changed files with 36,185 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: f454a770ef99c8ea7cc6f4758aab687d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
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/dragonfly_radiance.cli.doctree b/docs/.doctrees/dragonfly_radiance.cli.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.cli.translate.doctree b/docs/.doctrees/dragonfly_radiance.cli.translate.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.doctree b/docs/.doctrees/dragonfly_radiance.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.gridpar.doctree b/docs/.doctrees/dragonfly_radiance.gridpar.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.properties.building.doctree b/docs/.doctrees/dragonfly_radiance.properties.building.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.properties.context.doctree b/docs/.doctrees/dragonfly_radiance.properties.context.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.properties.doctree b/docs/.doctrees/dragonfly_radiance.properties.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.properties.model.doctree b/docs/.doctrees/dragonfly_radiance.properties.model.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.properties.room2d.doctree b/docs/.doctrees/dragonfly_radiance.properties.room2d.doctree
diff --git a/docs/.doctrees/dragonfly_radiance.properties.story.doctree b/docs/.doctrees/dragonfly_radiance.properties.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_radiance/gridpar.html b/docs/_modules/dragonfly_radiance/gridpar.html
diff --git a/docs/_modules/dragonfly_radiance/properties/building.html b/docs/_modules/dragonfly_radiance/properties/building.html
diff --git a/docs/_modules/dragonfly_radiance/properties/context.html b/docs/_modules/dragonfly_radiance/properties/context.html
diff --git a/docs/_modules/dragonfly_radiance/properties/model.html b/docs/_modules/dragonfly_radiance/properties/model.html
diff --git a/docs/_modules/dragonfly_radiance/properties/room2d.html b/docs/_modules/dragonfly_radiance/properties/room2d.html
diff --git a/docs/_modules/dragonfly_radiance/properties/story.html b/docs/_modules/dragonfly_radiance/properties/story.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,14 @@
+CLI Docs
+========
+
+Installation
+------------
+
+To check if the command line is installed correctly use ``dragonfly-radiance --help``
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   translate
diff --git a/docs/_sources/cli/translate.rst.txt b/docs/_sources/cli/translate.rst.txt
@@ -0,0 +1,6 @@
+translate
+=========
+
+.. click:: dragonfly_radiance.cli.translate:translate
+   :prog: dragonfly-radiance translate
+   :show-nested:
diff --git a/docs/_sources/dragonfly_radiance.cli.rst.txt b/docs/_sources/dragonfly_radiance.cli.rst.txt
@@ -0,0 +1,18 @@
+dragonfly\_radiance.cli package
+===============================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_radiance.cli.translate
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_radiance.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.cli.translate.rst.txt b/docs/_sources/dragonfly_radiance.cli.translate.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.cli.translate module
+========================================
+
+.. automodule:: dragonfly_radiance.cli.translate
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.gridpar.rst.txt b/docs/_sources/dragonfly_radiance.gridpar.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.gridpar module
+==================================
+
+.. automodule:: dragonfly_radiance.gridpar
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.properties.building.rst.txt b/docs/_sources/dragonfly_radiance.properties.building.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.building module
+==============================================
+
+.. automodule:: dragonfly_radiance.properties.building
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.properties.context.rst.txt b/docs/_sources/dragonfly_radiance.properties.context.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.context module
+=============================================
+
+.. automodule:: dragonfly_radiance.properties.context
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.properties.model.rst.txt b/docs/_sources/dragonfly_radiance.properties.model.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.model module
+===========================================
+
+.. automodule:: dragonfly_radiance.properties.model
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.properties.room2d.rst.txt b/docs/_sources/dragonfly_radiance.properties.room2d.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.room2d module
+============================================
+
+.. automodule:: dragonfly_radiance.properties.room2d
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.properties.rst.txt b/docs/_sources/dragonfly_radiance.properties.rst.txt
@@ -0,0 +1,22 @@
+dragonfly\_radiance.properties package
+======================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_radiance.properties.building
+   dragonfly_radiance.properties.context
+   dragonfly_radiance.properties.model
+   dragonfly_radiance.properties.room2d
+   dragonfly_radiance.properties.story
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_radiance.properties
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.properties.story.rst.txt b/docs/_sources/dragonfly_radiance.properties.story.rst.txt
@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.story module
+===========================================
+
+.. automodule:: dragonfly_radiance.properties.story
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/dragonfly_radiance.rst.txt b/docs/_sources/dragonfly_radiance.rst.txt
@@ -0,0 +1,27 @@
+dragonfly\_radiance package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_radiance.cli
+   dragonfly_radiance.properties
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_radiance.gridpar
+
+Module contents
+---------------
+
+.. automodule:: dragonfly_radiance
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,43 @@
+Welcome to dragonfly-radiance's documentation!
+============================================
+
+.. image:: http://www.ladybug.tools/assets/img/dragonfly.png
+
+`Radiance <https://radiance-online.org/>`_ extension for `dragonfly <https://github.com/ladybug-tools/dragonfly-core/>`_
+
+Dragonfly-radiance adds Radiance functionalities to dragonfly.
+
+
+Installation
+============
+
+``pip install -U dragonfly-radiance``.
+
+To check if the command line is installed correctly use ``dragonfly-radiance --help``
+
+CLI Docs
+=============
+
+For command line interface documentation and API documentation see the pages below.
+
+
+.. toctree::
+   :maxdepth: 2
+
+   cli/index
+
+
+dragonfly_radiance
+================
+
+.. toctree::
+  :maxdepth: 4
+
+  modules
+
+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 @@
+dragonfly_radiance
+==================
+
+.. toctree::
+   :maxdepth: 4
+
+   dragonfly_radiance