-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
- Loading branch information
There are no files selected for viewing
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: 21e92ce84bfa8b8e5ace52672d74045a | ||
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.
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: |
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: |
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: |
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 |
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: |
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 |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |
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: |