deploy: update docs

ladybug-tools · Nov 16, 2024 · 2ed476c · 2ed476c
commit 2ed476c
Show file tree

Hide file tree

Showing 115 changed files with 29,642 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: cc06138507ae3613e0aa0e0d8a805db5
+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/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/lbt_recipes.cli.doctree b/docs/.doctrees/lbt_recipes.cli.doctree
diff --git a/docs/.doctrees/lbt_recipes.doctree b/docs/.doctrees/lbt_recipes.doctree
diff --git a/docs/.doctrees/lbt_recipes.recipe.doctree b/docs/.doctrees/lbt_recipes.recipe.doctree
diff --git a/docs/.doctrees/lbt_recipes.settings.doctree b/docs/.doctrees/lbt_recipes.settings.doctree
diff --git a/docs/.doctrees/lbt_recipes.version.doctree b/docs/.doctrees/lbt_recipes.version.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/index.html b/docs/_modules/index.html
diff --git a/docs/_modules/lbt_recipes/recipe.html b/docs/_modules/lbt_recipes/recipe.html
diff --git a/docs/_modules/lbt_recipes/settings.html b/docs/_modules/lbt_recipes/settings.html
diff --git a/docs/_modules/lbt_recipes/version.html b/docs/_modules/lbt_recipes/version.html
diff --git a/docs/_sources/cli/index.rst.txt b/docs/_sources/cli/index.rst.txt
@@ -0,0 +1,10 @@
+CLI
+===
+
+
+Commands
+--------
+.. toctree::
+   :maxdepth: 1
+
+   main
diff --git a/docs/_sources/cli/main.rst.txt b/docs/_sources/cli/main.rst.txt
@@ -0,0 +1,7 @@
+main
+====
+
+.. click:: lbt_recipes.cli.__init__:main
+   :prog: lbt-recipes
+   :show-nested:
+   :commands: run ,viz
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,42 @@
+Welcome to lbt-recipes' documentation!
+=======================================
+
+A collection of recipes that ship with the Ladybug Tools plugins.
+
+This includes Radiance recipes, which automate the process of running daylight and radiation studies using `Radiance <https://radiance-online.org/>`_.
+
+It also includes microclimate mapping recipes, which spatially map thermal comfort using `EnergyPlus <https://github.com/NREL/EnergyPlus/>`_ and `Radiance <https://radiance-online.org/>`_.
+
+Installation
+============
+
+To install the library use ``pip install -U lbt-recipes``.
+
+To check if the command line interface is installed correctly use ``lbt-recipes viz`` and you
+should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!
+
+CLI Docs
+========
+
+For command line interface documentation and API documentation see the pages below.
+
+.. toctree::
+   :maxdepth: 2
+
+   cli//index
+
+
+lbt_recipes
+=============
+
+.. toctree::
+  :maxdepth: 4
+
+  modules
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/lbt_recipes.cli.rst.txt b/docs/_sources/lbt_recipes.cli.rst.txt
@@ -0,0 +1,10 @@
+lbt\_recipes.cli package
+========================
+
+Module contents
+---------------
+
+.. automodule:: lbt_recipes.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/lbt_recipes.recipe.rst.txt b/docs/_sources/lbt_recipes.recipe.rst.txt
@@ -0,0 +1,7 @@
+lbt\_recipes.recipe module
+==========================
+
+.. automodule:: lbt_recipes.recipe
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/lbt_recipes.rst.txt b/docs/_sources/lbt_recipes.rst.txt
@@ -0,0 +1,28 @@
+lbt\_recipes package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   lbt_recipes.cli
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   lbt_recipes.recipe
+   lbt_recipes.settings
+   lbt_recipes.version
+
+Module contents
+---------------
+
+.. automodule:: lbt_recipes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/lbt_recipes.settings.rst.txt b/docs/_sources/lbt_recipes.settings.rst.txt
@@ -0,0 +1,7 @@
+lbt\_recipes.settings module
+============================
+
+.. automodule:: lbt_recipes.settings
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/lbt_recipes.version.rst.txt b/docs/_sources/lbt_recipes.version.rst.txt
@@ -0,0 +1,7 @@
+lbt\_recipes.version module
+===========================
+
+.. automodule:: lbt_recipes.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+lbt_recipes
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   lbt_recipes