-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# documentation |
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: 560323fe1506cbc9a0591b7f8e1ca1bb | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# documentation |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
baseline | ||
======== | ||
|
||
.. click:: honeybee_energy.cli.baseline:baseline | ||
:prog: honeybee-energy baseline | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
edit | ||
==== | ||
|
||
.. click:: honeybee_energy.cli.edit:edit | ||
:prog: honeybee-energy edit | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
CLI Docs | ||
======== | ||
|
||
Installation | ||
------------ | ||
|
||
To check if the command line interface is installed correctly use `honeybee-energy --help`. | ||
|
||
Commands | ||
-------- | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
main | ||
setconfig | ||
validate | ||
settings | ||
baseline | ||
translate | ||
edit | ||
simulate | ||
result | ||
lib |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
lib | ||
=== | ||
|
||
.. click:: honeybee_energy.cli.lib:lib | ||
:prog: honeybee-energy lib | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
main | ||
==== | ||
|
||
.. click:: honeybee_energy.cli.__init__:energy | ||
:prog: honeybee-energy | ||
:show-nested: | ||
:commands: config |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
result | ||
====== | ||
|
||
.. click:: honeybee_energy.cli.result:result | ||
:prog: honeybee-energy result | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
setconfig | ||
========= | ||
|
||
.. click:: honeybee_energy.cli.setconfig:set_config | ||
:prog: honeybee-energy set-config | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
settings | ||
======== | ||
|
||
.. click:: honeybee_energy.cli.settings:settings | ||
:prog: honeybee-energy settings | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
simulate | ||
======== | ||
|
||
.. click:: honeybee_energy.cli.simulate:simulate | ||
:prog: honeybee-energy simulate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
translate | ||
========= | ||
|
||
.. click:: honeybee_energy.cli.translate:translate | ||
:prog: honeybee-energy translate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
validate | ||
======== | ||
|
||
.. click:: honeybee_energy.cli.validate:validate | ||
:prog: honeybee-energy validate | ||
:show-nested: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.altnumber module | ||
================================= | ||
|
||
.. automodule:: honeybee_energy.altnumber | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.baseline.create module | ||
======================================= | ||
|
||
.. automodule:: honeybee_energy.baseline.create | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
honeybee\_energy.baseline.data package | ||
====================================== | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: honeybee_energy.baseline.data | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.baseline.pci module | ||
==================================== | ||
|
||
.. automodule:: honeybee_energy.baseline.pci | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.baseline.result module | ||
======================================= | ||
|
||
.. automodule:: honeybee_energy.baseline.result | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
honeybee\_energy.baseline package | ||
================================= | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
honeybee_energy.baseline.data | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
honeybee_energy.baseline.create | ||
honeybee_energy.baseline.pci | ||
honeybee_energy.baseline.result | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: honeybee_energy.baseline | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.boundarycondition module | ||
========================================= | ||
|
||
.. automodule:: honeybee_energy.boundarycondition | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.baseline module | ||
==================================== | ||
|
||
.. automodule:: honeybee_energy.cli.baseline | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.edit module | ||
================================ | ||
|
||
.. automodule:: honeybee_energy.cli.edit | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.lib module | ||
=============================== | ||
|
||
.. automodule:: honeybee_energy.cli.lib | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.result module | ||
================================== | ||
|
||
.. automodule:: honeybee_energy.cli.result | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
honeybee\_energy.cli package | ||
============================ | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
honeybee_energy.cli.baseline | ||
honeybee_energy.cli.edit | ||
honeybee_energy.cli.lib | ||
honeybee_energy.cli.result | ||
honeybee_energy.cli.setconfig | ||
honeybee_energy.cli.settings | ||
honeybee_energy.cli.simulate | ||
honeybee_energy.cli.translate | ||
honeybee_energy.cli.validate | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: honeybee_energy.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.setconfig module | ||
===================================== | ||
|
||
.. automodule:: honeybee_energy.cli.setconfig | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.settings module | ||
==================================== | ||
|
||
.. automodule:: honeybee_energy.cli.settings | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.simulate module | ||
==================================== | ||
|
||
.. automodule:: honeybee_energy.cli.simulate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.translate module | ||
===================================== | ||
|
||
.. automodule:: honeybee_energy.cli.translate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.cli.validate module | ||
==================================== | ||
|
||
.. automodule:: honeybee_energy.cli.validate | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.config module | ||
============================== | ||
|
||
.. automodule:: honeybee_energy.config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.air module | ||
======================================== | ||
|
||
.. automodule:: honeybee_energy.construction.air | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.dictutil module | ||
============================================= | ||
|
||
.. automodule:: honeybee_energy.construction.dictutil | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.dynamic module | ||
============================================ | ||
|
||
.. automodule:: honeybee_energy.construction.dynamic | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.opaque module | ||
=========================================== | ||
|
||
.. automodule:: honeybee_energy.construction.opaque | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
honeybee\_energy.construction package | ||
===================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
honeybee_energy.construction.air | ||
honeybee_energy.construction.dictutil | ||
honeybee_energy.construction.dynamic | ||
honeybee_energy.construction.opaque | ||
honeybee_energy.construction.shade | ||
honeybee_energy.construction.window | ||
honeybee_energy.construction.windowshade | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: honeybee_energy.construction | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.shade module | ||
========================================== | ||
|
||
.. automodule:: honeybee_energy.construction.shade | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.window module | ||
=========================================== | ||
|
||
.. automodule:: honeybee_energy.construction.window | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.construction.windowshade module | ||
================================================ | ||
|
||
.. automodule:: honeybee_energy.construction.windowshade | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.constructionset module | ||
======================================= | ||
|
||
.. automodule:: honeybee_energy.constructionset | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.dictutil module | ||
================================ | ||
|
||
.. automodule:: honeybee_energy.dictutil | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
honeybee\_energy.generator.loadcenter module | ||
============================================ | ||
|
||
.. automodule:: honeybee_energy.generator.loadcenter | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |