deploy: update docs

ladybug-tools · Oct 29, 2024 · ac403c9 · ac403c9
commit ac403c9
Show file tree

Hide file tree

Showing 122 changed files with 31,677 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: d38046bf964514bdd7b7159b3bb313e5
+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/ladybug_geometry_polyskel.cli.doctree b/docs/.doctrees/ladybug_geometry_polyskel.cli.doctree
diff --git a/docs/.doctrees/ladybug_geometry_polyskel.doctree b/docs/.doctrees/ladybug_geometry_polyskel.doctree
diff --git a/docs/.doctrees/ladybug_geometry_polyskel.offset.doctree b/docs/.doctrees/ladybug_geometry_polyskel.offset.doctree
diff --git a/docs/.doctrees/ladybug_geometry_polyskel.polygraph.doctree b/docs/.doctrees/ladybug_geometry_polyskel.polygraph.doctree
diff --git a/docs/.doctrees/ladybug_geometry_polyskel.polyskel.doctree b/docs/.doctrees/ladybug_geometry_polyskel.polyskel.doctree
diff --git a/docs/.doctrees/ladybug_geometry_polyskel.polysplit.doctree b/docs/.doctrees/ladybug_geometry_polyskel.polysplit.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/index.html b/docs/_modules/index.html
diff --git a/docs/_modules/ladybug_geometry_polyskel/cli.html b/docs/_modules/ladybug_geometry_polyskel/cli.html
diff --git a/docs/_modules/ladybug_geometry_polyskel/offset.html b/docs/_modules/ladybug_geometry_polyskel/offset.html
diff --git a/docs/_modules/ladybug_geometry_polyskel/polygraph.html b/docs/_modules/ladybug_geometry_polyskel/polygraph.html
diff --git a/docs/_modules/ladybug_geometry_polyskel/polyskel.html b/docs/_modules/ladybug_geometry_polyskel/polyskel.html
diff --git a/docs/_modules/ladybug_geometry_polyskel/polysplit.html b/docs/_modules/ladybug_geometry_polyskel/polysplit.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:: ladybug_geometry_polyskel.cli.__init__:main
+   :prog: ladybug-geometry-polyskel
+   :show-nested:
+   :commands: perimeter-core-subfaces
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,36 @@
+Welcome to Ladybug Geometry Polyskel's documentation!
+===================================
+
+.. image:: http://www.ladybug.tools/assets/img/ladybug.png
+
+A library with straight skeleton methods using ladybug-geometry.
+
+Installation
+============
+
+``pip install -U ladybug-geometry-polyskel``
+
+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/ladybug_geometry_polyskel.cli.rst.txt b/docs/_sources/ladybug_geometry_polyskel.cli.rst.txt
@@ -0,0 +1,10 @@
+ladybug\_geometry\_polyskel.cli package
+=======================================
+
+Module contents
+---------------
+
+.. automodule:: ladybug_geometry_polyskel.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/ladybug_geometry_polyskel.offset.rst.txt b/docs/_sources/ladybug_geometry_polyskel.offset.rst.txt
@@ -0,0 +1,7 @@
+ladybug\_geometry\_polyskel.offset module
+=========================================
+
+.. automodule:: ladybug_geometry_polyskel.offset
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/ladybug_geometry_polyskel.polygraph.rst.txt b/docs/_sources/ladybug_geometry_polyskel.polygraph.rst.txt
@@ -0,0 +1,7 @@
+ladybug\_geometry\_polyskel.polygraph module
+============================================
+
+.. automodule:: ladybug_geometry_polyskel.polygraph
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/ladybug_geometry_polyskel.polyskel.rst.txt b/docs/_sources/ladybug_geometry_polyskel.polyskel.rst.txt
@@ -0,0 +1,7 @@
+ladybug\_geometry\_polyskel.polyskel module
+===========================================
+
+.. automodule:: ladybug_geometry_polyskel.polyskel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/ladybug_geometry_polyskel.polysplit.rst.txt b/docs/_sources/ladybug_geometry_polyskel.polysplit.rst.txt
@@ -0,0 +1,7 @@
+ladybug\_geometry\_polyskel.polysplit module
+============================================
+
+.. automodule:: ladybug_geometry_polyskel.polysplit
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/ladybug_geometry_polyskel.rst.txt b/docs/_sources/ladybug_geometry_polyskel.rst.txt
@@ -0,0 +1,29 @@
+ladybug\_geometry\_polyskel package
+===================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ladybug_geometry_polyskel.cli
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ladybug_geometry_polyskel.offset
+   ladybug_geometry_polyskel.polygraph
+   ladybug_geometry_polyskel.polyskel
+   ladybug_geometry_polyskel.polysplit
+
+Module contents
+---------------
+
+.. automodule:: ladybug_geometry_polyskel
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+ladybug_geometry_polyskel
+=========================
+
+.. toctree::
+   :maxdepth: 4
+
+   ladybug_geometry_polyskel