Skip to content

Commit

Permalink
deploy: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed Nov 14, 2024
0 parents commit d79f710
Show file tree
Hide file tree
Showing 280 changed files with 123,881 additions and 0 deletions.
1 change: 1 addition & 0 deletions .nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# documentation
4 changes: 4 additions & 0 deletions docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -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: e64531a24038b05942fe986a0a0213fd
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/cli/datacollection.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/epw.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/map.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/mtx.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/sql.doctree
Binary file not shown.
Binary file added docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.adaptive.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.asv.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.at.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.chart.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.cli.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.cli.epw.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.cli.map.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.cli.mtx.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.cli.sql.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.clo.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.collection.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.di.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.hi.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.humidex.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.local.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.map.air.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.map.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.map.irr.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.map.mrt.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.map.tcp.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.map.utci.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.parameter.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.pet.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.pmv.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.solarcal.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.ts.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.utci.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.wbgt.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_comfort.wc.doctree
Binary file not shown.
Binary file added docs/.doctrees/modules.doctree
Binary file not shown.
Empty file added docs/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# documentation
865 changes: 865 additions & 0 deletions docs/_modules/index.html

Large diffs are not rendered by default.

1,486 changes: 1,486 additions & 0 deletions docs/_modules/ladybug_comfort/adaptive.html

Large diffs are not rendered by default.

911 changes: 911 additions & 0 deletions docs/_modules/ladybug_comfort/asv.html

Large diffs are not rendered by default.

941 changes: 941 additions & 0 deletions docs/_modules/ladybug_comfort/at.html

Large diffs are not rendered by default.

1,759 changes: 1,759 additions & 0 deletions docs/_modules/ladybug_comfort/chart/adaptive.html

Large diffs are not rendered by default.

2,014 changes: 2,014 additions & 0 deletions docs/_modules/ladybug_comfort/chart/polygonpmv.html

Large diffs are not rendered by default.

1,421 changes: 1,421 additions & 0 deletions docs/_modules/ladybug_comfort/chart/polygonutci.html

Large diffs are not rendered by default.

890 changes: 890 additions & 0 deletions docs/_modules/ladybug_comfort/clo.html

Large diffs are not rendered by default.

1,296 changes: 1,296 additions & 0 deletions docs/_modules/ladybug_comfort/collection/adaptive.html

Large diffs are not rendered by default.

939 changes: 939 additions & 0 deletions docs/_modules/ladybug_comfort/collection/base.html

Large diffs are not rendered by default.

1,297 changes: 1,297 additions & 0 deletions docs/_modules/ladybug_comfort/collection/pet.html

Large diffs are not rendered by default.

1,504 changes: 1,504 additions & 0 deletions docs/_modules/ladybug_comfort/collection/pmv.html

Large diffs are not rendered by default.

1,580 changes: 1,580 additions & 0 deletions docs/_modules/ladybug_comfort/collection/solarcal.html

Large diffs are not rendered by default.

1,293 changes: 1,293 additions & 0 deletions docs/_modules/ladybug_comfort/collection/utci.html

Large diffs are not rendered by default.

875 changes: 875 additions & 0 deletions docs/_modules/ladybug_comfort/degreetime.html

Large diffs are not rendered by default.

926 changes: 926 additions & 0 deletions docs/_modules/ladybug_comfort/di.html

Large diffs are not rendered by default.

938 changes: 938 additions & 0 deletions docs/_modules/ladybug_comfort/hi.html

Large diffs are not rendered by default.

919 changes: 919 additions & 0 deletions docs/_modules/ladybug_comfort/humidex.html

Large diffs are not rendered by default.

939 changes: 939 additions & 0 deletions docs/_modules/ladybug_comfort/local.html

Large diffs are not rendered by default.

921 changes: 921 additions & 0 deletions docs/_modules/ladybug_comfort/map/air.html

Large diffs are not rendered by default.

1,188 changes: 1,188 additions & 0 deletions docs/_modules/ladybug_comfort/parameter/adaptive.html

Large diffs are not rendered by default.

1,048 changes: 1,048 additions & 0 deletions docs/_modules/ladybug_comfort/parameter/pet.html

Large diffs are not rendered by default.

1,066 changes: 1,066 additions & 0 deletions docs/_modules/ladybug_comfort/parameter/pmv.html

Large diffs are not rendered by default.

1,055 changes: 1,055 additions & 0 deletions docs/_modules/ladybug_comfort/parameter/solarcal.html

Large diffs are not rendered by default.

1,344 changes: 1,344 additions & 0 deletions docs/_modules/ladybug_comfort/parameter/utci.html

Large diffs are not rendered by default.

1,457 changes: 1,457 additions & 0 deletions docs/_modules/ladybug_comfort/pet.html

Large diffs are not rendered by default.

1,572 changes: 1,572 additions & 0 deletions docs/_modules/ladybug_comfort/pmv.html

Large diffs are not rendered by default.

1,702 changes: 1,702 additions & 0 deletions docs/_modules/ladybug_comfort/solarcal.html

Large diffs are not rendered by default.

922 changes: 922 additions & 0 deletions docs/_modules/ladybug_comfort/ts.html

Large diffs are not rendered by default.

1,257 changes: 1,257 additions & 0 deletions docs/_modules/ladybug_comfort/utci.html

Large diffs are not rendered by default.

922 changes: 922 additions & 0 deletions docs/_modules/ladybug_comfort/wbgt.html

Large diffs are not rendered by default.

1,013 changes: 1,013 additions & 0 deletions docs/_modules/ladybug_comfort/wc.html

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions docs/_sources/cli/datacollection.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
datacollection
==============

.. click:: ladybug_comfort.cli.datacollection:datacollection
:prog: ladybug-comfort data-collection
:show-nested:
6 changes: 6 additions & 0 deletions docs/_sources/cli/epw.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
epw
===

.. click:: ladybug_comfort.cli.epw:epw
:prog: ladybug-comfort epw
:show-nested:
18 changes: 18 additions & 0 deletions docs/_sources/cli/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
CLI Docs
========

Installation
------------

To check if the command line is installed correctly use ``ladybug-comfort --help``

Commands
--------
.. toctree::
:maxdepth: 1

map
mtx
epw
datacollection
sql
6 changes: 6 additions & 0 deletions docs/_sources/cli/map.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
map
===

.. click:: ladybug_comfort.cli.map:map
:prog: ladybug-comfort map
:show-nested:
6 changes: 6 additions & 0 deletions docs/_sources/cli/mtx.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
mtx
===

.. click:: ladybug_comfort.cli.mtx:mtx
:prog: ladybug-comfort mtx
:show-nested:
6 changes: 6 additions & 0 deletions docs/_sources/cli/sql.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
sql
===

.. click:: ladybug_comfort.cli.sql:sql
:prog: ladybug-comfort sql
:show-nested:
46 changes: 46 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Welcome to Ladybug Comfort's documentation!
===========================================

.. image:: http://www.ladybug.tools/assets/img/ladybug.png

Ladybug-comfort is a Python library that adds thermal comfort functionalities to
`ladybug-core <https://github.com/ladybug-tools/ladybug/>`_.

Installation
============

``pip install -U ladybug-comfort``

If you want to also include the dependencies needed for thermal mapping use.

``pip install -U honeybee-energy[mapping]``

To check if the command line interface is installed correctly use ``ladybug-comfort --help``


CLI Docs
=============

For command line interface documentation and API documentation see the pages below.


.. toctree::
:maxdepth: 2

cli/index


ladybug_comfort
===============

.. toctree::
:maxdepth: 4

modules

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.adaptive.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.adaptive module
================================

.. automodule:: ladybug_comfort.adaptive
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.asv.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.asv module
===========================

.. automodule:: ladybug_comfort.asv
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.at.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.at module
==========================

.. automodule:: ladybug_comfort.at
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.chart.adaptive.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.chart.adaptive module
======================================

.. automodule:: ladybug_comfort.chart.adaptive
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.chart.polygonpmv.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.chart.polygonpmv module
========================================

.. automodule:: ladybug_comfort.chart.polygonpmv
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.chart.polygonutci.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.chart.polygonutci module
=========================================

.. automodule:: ladybug_comfort.chart.polygonutci
:members:
:undoc-members:
:show-inheritance:
20 changes: 20 additions & 0 deletions docs/_sources/ladybug_comfort.chart.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
ladybug\_comfort.chart package
==============================

Submodules
----------

.. toctree::
:maxdepth: 4

ladybug_comfort.chart.adaptive
ladybug_comfort.chart.polygonpmv
ladybug_comfort.chart.polygonutci

Module contents
---------------

.. automodule:: ladybug_comfort.chart
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.cli.datacollection.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.cli.datacollection module
==========================================

.. automodule:: ladybug_comfort.cli.datacollection
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.cli.epw.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.cli.epw module
===============================

.. automodule:: ladybug_comfort.cli.epw
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.cli.map.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.cli.map module
===============================

.. automodule:: ladybug_comfort.cli.map
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.cli.mtx.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.cli.mtx module
===============================

.. automodule:: ladybug_comfort.cli.mtx
:members:
:undoc-members:
:show-inheritance:
22 changes: 22 additions & 0 deletions docs/_sources/ladybug_comfort.cli.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
ladybug\_comfort.cli package
============================

Submodules
----------

.. toctree::
:maxdepth: 4

ladybug_comfort.cli.datacollection
ladybug_comfort.cli.epw
ladybug_comfort.cli.map
ladybug_comfort.cli.mtx
ladybug_comfort.cli.sql

Module contents
---------------

.. automodule:: ladybug_comfort.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.cli.sql.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.cli.sql module
===============================

.. automodule:: ladybug_comfort.cli.sql
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.clo.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.clo module
===========================

.. automodule:: ladybug_comfort.clo
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.collection.adaptive.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.collection.adaptive module
===========================================

.. automodule:: ladybug_comfort.collection.adaptive
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.collection.base.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.collection.base module
=======================================

.. automodule:: ladybug_comfort.collection.base
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.collection.pet.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.collection.pet module
======================================

.. automodule:: ladybug_comfort.collection.pet
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.collection.pmv.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.collection.pmv module
======================================

.. automodule:: ladybug_comfort.collection.pmv
:members:
:undoc-members:
:show-inheritance:
23 changes: 23 additions & 0 deletions docs/_sources/ladybug_comfort.collection.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
ladybug\_comfort.collection package
===================================

Submodules
----------

.. toctree::
:maxdepth: 4

ladybug_comfort.collection.adaptive
ladybug_comfort.collection.base
ladybug_comfort.collection.pet
ladybug_comfort.collection.pmv
ladybug_comfort.collection.solarcal
ladybug_comfort.collection.utci

Module contents
---------------

.. automodule:: ladybug_comfort.collection
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.collection.solarcal.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.collection.solarcal module
===========================================

.. automodule:: ladybug_comfort.collection.solarcal
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.collection.utci.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.collection.utci module
=======================================

.. automodule:: ladybug_comfort.collection.utci
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.degreetime.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.degreetime module
==================================

.. automodule:: ladybug_comfort.degreetime
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.di.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.di module
==========================

.. automodule:: ladybug_comfort.di
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.hi.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.hi module
==========================

.. automodule:: ladybug_comfort.hi
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.humidex.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.humidex module
===============================

.. automodule:: ladybug_comfort.humidex
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.local.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.local module
=============================

.. automodule:: ladybug_comfort.local
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.map.air.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.map.air module
===============================

.. automodule:: ladybug_comfort.map.air
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.map.irr.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.map.irr module
===============================

.. automodule:: ladybug_comfort.map.irr
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_comfort.map.mrt.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ladybug\_comfort.map.mrt module
===============================

.. automodule:: ladybug_comfort.map.mrt
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit d79f710

Please sign in to comment.