Skip to content

Commit

Permalink
deploy: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed Dec 20, 2024
0 parents commit ecf9b9c
Show file tree
Hide file tree
Showing 250 changed files with 145,660 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
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: 21e92ce84bfa8b8e5ace52672d74045a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/cli/compare.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/create.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/edit.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/lib.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/main.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/setconfig.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/validate.doctree
Binary file not shown.
Binary file added docs/.doctrees/environment.pickle
Binary file not shown.
Binary file added docs/.doctrees/honeybee.altnumber.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.aperture.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.boundarycondition.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.checkdup.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.compare.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.create.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.edit.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.lib.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.setconfig.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.cli.validate.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.colorobj.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.config.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.dictutil.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.door.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.extensionutil.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.face.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.facetype.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.logutil.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.model.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.orientation.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.properties.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.room.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.search.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.shade.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.shademesh.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.typing.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.units.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.aperture.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.door.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.face.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.model.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.room.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.shade.doctree
Binary file not shown.
Binary file added docs/.doctrees/honeybee.writer.shademesh.doctree
Binary file not shown.
Binary file added docs/.doctrees/index.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
1,198 changes: 1,198 additions & 0 deletions docs/_modules/honeybee/altnumber.html

Large diffs are not rendered by default.

2,111 changes: 2,111 additions & 0 deletions docs/_modules/honeybee/aperture.html

Large diffs are not rendered by default.

1,533 changes: 1,533 additions & 0 deletions docs/_modules/honeybee/boundarycondition.html

Large diffs are not rendered by default.

1,327 changes: 1,327 additions & 0 deletions docs/_modules/honeybee/checkdup.html

Large diffs are not rendered by default.

1,379 changes: 1,379 additions & 0 deletions docs/_modules/honeybee/cli/validate.html

Large diffs are not rendered by default.

1,514 changes: 1,514 additions & 0 deletions docs/_modules/honeybee/colorobj.html

Large diffs are not rendered by default.

1,495 changes: 1,495 additions & 0 deletions docs/_modules/honeybee/config.html

Large diffs are not rendered by default.

1,202 changes: 1,202 additions & 0 deletions docs/_modules/honeybee/dictutil.html

Large diffs are not rendered by default.

1,850 changes: 1,850 additions & 0 deletions docs/_modules/honeybee/door.html

Large diffs are not rendered by default.

1,371 changes: 1,371 additions & 0 deletions docs/_modules/honeybee/extensionutil.html

Large diffs are not rendered by default.

3,504 changes: 3,504 additions & 0 deletions docs/_modules/honeybee/face.html

Large diffs are not rendered by default.

1,313 changes: 1,313 additions & 0 deletions docs/_modules/honeybee/facetype.html

Large diffs are not rendered by default.

1,227 changes: 1,227 additions & 0 deletions docs/_modules/honeybee/logutil.html

Large diffs are not rendered by default.

5,089 changes: 5,089 additions & 0 deletions docs/_modules/honeybee/model.html

Large diffs are not rendered by default.

1,292 changes: 1,292 additions & 0 deletions docs/_modules/honeybee/orientation.html

Large diffs are not rendered by default.

2,035 changes: 2,035 additions & 0 deletions docs/_modules/honeybee/properties.html

Large diffs are not rendered by default.

4,268 changes: 4,268 additions & 0 deletions docs/_modules/honeybee/room.html

Large diffs are not rendered by default.

1,255 changes: 1,255 additions & 0 deletions docs/_modules/honeybee/search.html

Large diffs are not rendered by default.

1,676 changes: 1,676 additions & 0 deletions docs/_modules/honeybee/shade.html

Large diffs are not rendered by default.

1,526 changes: 1,526 additions & 0 deletions docs/_modules/honeybee/shademesh.html

Large diffs are not rendered by default.

1,710 changes: 1,710 additions & 0 deletions docs/_modules/honeybee/typing.html

Large diffs are not rendered by default.

1,239 changes: 1,239 additions & 0 deletions docs/_modules/honeybee/units.html

Large diffs are not rendered by default.

1,167 changes: 1,167 additions & 0 deletions docs/_modules/index.html

Large diffs are not rendered by default.

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

.. click:: honeybee.cli.compare:compare
:prog: honeybee compare
:show-nested:
6 changes: 6 additions & 0 deletions docs/_sources/cli/create.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
create
======

.. click:: honeybee.cli.create:create
:prog: honeybee create
:show-nested:
6 changes: 6 additions & 0 deletions docs/_sources/cli/edit.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
edit
====

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

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

To check if the Honeybee command line interface is installed correctly try ``honeybee viz`` and you
should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!

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

main
compare
setconfig
lib
edit
validate
create
6 changes: 6 additions & 0 deletions docs/_sources/cli/lib.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
lib
===

.. click:: honeybee.cli.lib:lib
:prog: honeybee lib
:show-nested:
7 changes: 7 additions & 0 deletions docs/_sources/cli/main.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
main
====

.. click:: honeybee.cli.__init__:main
:prog: honeybee
:show-nested:
:commands: config ,viz
6 changes: 6 additions & 0 deletions docs/_sources/cli/setconfig.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
setconfig
=========

.. click:: honeybee.cli.setconfig:set_config
:prog: honeybee set-config
:show-nested:
6 changes: 6 additions & 0 deletions docs/_sources/cli/validate.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
validate
========

.. click:: honeybee.cli.validate:validate
:prog: honeybee validate
:show-nested:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.altnumber.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.altnumber module
=========================

.. automodule:: honeybee.altnumber
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.aperture.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.aperture module
========================

.. automodule:: honeybee.aperture
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.boundarycondition.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.boundarycondition module
=================================

.. automodule:: honeybee.boundarycondition
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.checkdup.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.checkdup module
========================

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

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

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

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

.. automodule:: honeybee.cli.lib
:members:
:undoc-members:
:show-inheritance:
23 changes: 23 additions & 0 deletions docs/_sources/honeybee.cli.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
honeybee.cli package
====================

Submodules
----------

.. toctree::
:maxdepth: 4

honeybee.cli.compare
honeybee.cli.create
honeybee.cli.edit
honeybee.cli.lib
honeybee.cli.setconfig
honeybee.cli.validate

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

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

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

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

.. automodule:: honeybee.colorobj
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.config.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.config module
======================

.. automodule:: honeybee.config
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.dictutil.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.dictutil module
========================

.. automodule:: honeybee.dictutil
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.door.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.door module
====================

.. automodule:: honeybee.door
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.extensionutil.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.extensionutil module
=============================

.. automodule:: honeybee.extensionutil
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.face.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.face module
====================

.. automodule:: honeybee.face
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.facetype.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.facetype module
========================

.. automodule:: honeybee.facetype
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.logutil.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.logutil module
=======================

.. automodule:: honeybee.logutil
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.model.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.model module
=====================

.. automodule:: honeybee.model
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.orientation.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.orientation module
===========================

.. automodule:: honeybee.orientation
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.properties.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.properties module
==========================

.. automodule:: honeybee.properties
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.room.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.room module
====================

.. automodule:: honeybee.room
:members:
:undoc-members:
:show-inheritance:
47 changes: 47 additions & 0 deletions docs/_sources/honeybee.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
honeybee package
================

Subpackages
-----------

.. toctree::
:maxdepth: 4

honeybee.cli
honeybee.writer

Submodules
----------

.. toctree::
:maxdepth: 4

honeybee.altnumber
honeybee.aperture
honeybee.boundarycondition
honeybee.checkdup
honeybee.colorobj
honeybee.config
honeybee.dictutil
honeybee.door
honeybee.extensionutil
honeybee.face
honeybee.facetype
honeybee.logutil
honeybee.model
honeybee.orientation
honeybee.properties
honeybee.room
honeybee.search
honeybee.shade
honeybee.shademesh
honeybee.typing
honeybee.units

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

.. automodule:: honeybee
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.search.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.search module
======================

.. automodule:: honeybee.search
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.shade.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.shade module
=====================

.. automodule:: honeybee.shade
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.shademesh.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.shademesh module
=========================

.. automodule:: honeybee.shademesh
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.typing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.typing module
======================

.. automodule:: honeybee.typing
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.units.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.units module
=====================

.. automodule:: honeybee.units
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.writer.aperture.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.writer.aperture module
===============================

.. automodule:: honeybee.writer.aperture
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.writer.door.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.writer.door module
===========================

.. automodule:: honeybee.writer.door
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/honeybee.writer.face.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
honeybee.writer.face module
===========================

.. automodule:: honeybee.writer.face
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit ecf9b9c

Please sign in to comment.