-
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 @@ | ||
|
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: 40af715a0db8e7637cf7a273aeb72f46 | ||
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.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
CLI Docs | ||
======== | ||
|
||
Installation | ||
------------ | ||
|
||
To check if the command line is installed correctly use ``ladybug-rhino --help`` | ||
|
||
Commands | ||
-------- | ||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
main |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
main | ||
==== | ||
|
||
.. click:: ladybug_rhino.cli.__init__:main | ||
:prog: ladybug-rhino | ||
:show-nested: | ||
:commands: viz ,setup-user-environment ,set-python-search ,copy-gh-components ,remove-gh-components ,setup-resources ,change-installed-version ,config |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
Welcome to Ladybug-rhino's documentation! | ||
========================================= | ||
|
||
.. image:: http://www.ladybug.tools/assets/img/ladybug.png | ||
|
||
Ladybug-rhino is a library for communicating between Ladybug Tools core libraries and Rhinoceros CAD. | ||
|
||
This library is used by both the Grasshopper and Rhino plugins to communicate with | ||
the ladybug core Python library. Note that this library has dependencies | ||
on Rhino SDK and Grasshopper SDK. It is NOT intended to be run with cPython with | ||
the exception of running the CLI. | ||
|
||
Installation | ||
============ | ||
|
||
``pip install -U ladybug-rhino`` | ||
|
||
CLI Docs | ||
============= | ||
|
||
For command line interface documentation and API documentation see the pages below. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
cli/index | ||
|
||
|
||
ladybug_rhino | ||
============= | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
modules | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.bakedisplay module | ||
================================= | ||
|
||
.. automodule:: ladybug_rhino.bakedisplay | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.bakegeometry module | ||
================================== | ||
|
||
.. automodule:: ladybug_rhino.bakegeometry | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.bakeobjects module | ||
================================= | ||
|
||
.. automodule:: ladybug_rhino.bakeobjects | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
ladybug\_rhino.cli package | ||
========================== | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_rhino.cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.color module | ||
=========================== | ||
|
||
.. automodule:: ladybug_rhino.color | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.colorize module | ||
============================== | ||
|
||
.. automodule:: ladybug_rhino.colorize | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.command module | ||
============================= | ||
|
||
.. automodule:: ladybug_rhino.command | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.config module | ||
============================ | ||
|
||
.. automodule:: ladybug_rhino.config | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.download module | ||
============================== | ||
|
||
.. automodule:: ladybug_rhino.download | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.fromgeometry module | ||
================================== | ||
|
||
.. automodule:: ladybug_rhino.fromgeometry | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.fromobjects module | ||
================================= | ||
|
||
.. automodule:: ladybug_rhino.fromobjects | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.ghpath module | ||
============================ | ||
|
||
.. automodule:: ladybug_rhino.ghpath | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.grasshopper module | ||
================================= | ||
|
||
.. automodule:: ladybug_rhino.grasshopper | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.intersect module | ||
=============================== | ||
|
||
.. automodule:: ladybug_rhino.intersect | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.light module | ||
=========================== | ||
|
||
.. automodule:: ladybug_rhino.light | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.openstudio module | ||
================================ | ||
|
||
.. automodule:: ladybug_rhino.openstudio | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.planarize module | ||
=============================== | ||
|
||
.. automodule:: ladybug_rhino.planarize | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.preview module | ||
============================= | ||
|
||
.. automodule:: ladybug_rhino.preview | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.pythonpath module | ||
================================ | ||
|
||
.. automodule:: ladybug_rhino.pythonpath | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.resourcepath module | ||
================================== | ||
|
||
.. automodule:: ladybug_rhino.resourcepath | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
ladybug\_rhino package | ||
====================== | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_rhino.cli | ||
ladybug_rhino.versioning | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_rhino.bakedisplay | ||
ladybug_rhino.bakegeometry | ||
ladybug_rhino.bakeobjects | ||
ladybug_rhino.color | ||
ladybug_rhino.colorize | ||
ladybug_rhino.command | ||
ladybug_rhino.config | ||
ladybug_rhino.download | ||
ladybug_rhino.fromgeometry | ||
ladybug_rhino.fromobjects | ||
ladybug_rhino.ghpath | ||
ladybug_rhino.grasshopper | ||
ladybug_rhino.intersect | ||
ladybug_rhino.light | ||
ladybug_rhino.openstudio | ||
ladybug_rhino.planarize | ||
ladybug_rhino.preview | ||
ladybug_rhino.pythonpath | ||
ladybug_rhino.resourcepath | ||
ladybug_rhino.text | ||
ladybug_rhino.togeometry | ||
ladybug_rhino.viewport | ||
ladybug_rhino.visset | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_rhino | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.text module | ||
========================== | ||
|
||
.. automodule:: ladybug_rhino.text | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.togeometry module | ||
================================ | ||
|
||
.. automodule:: ladybug_rhino.togeometry | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.change module | ||
======================================= | ||
|
||
.. automodule:: ladybug_rhino.versioning.change | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.component module | ||
========================================== | ||
|
||
.. automodule:: ladybug_rhino.versioning.component | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.diff module | ||
===================================== | ||
|
||
.. automodule:: ladybug_rhino.versioning.diff | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.export module | ||
======================================= | ||
|
||
.. automodule:: ladybug_rhino.versioning.export | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.gather module | ||
======================================= | ||
|
||
.. automodule:: ladybug_rhino.versioning.gather | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.legacy module | ||
======================================= | ||
|
||
.. automodule:: ladybug_rhino.versioning.legacy | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.release module | ||
======================================== | ||
|
||
.. automodule:: ladybug_rhino.versioning.release | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
ladybug\_rhino.versioning package | ||
================================= | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_rhino.versioning.change | ||
ladybug_rhino.versioning.component | ||
ladybug_rhino.versioning.diff | ||
ladybug_rhino.versioning.export | ||
ladybug_rhino.versioning.gather | ||
ladybug_rhino.versioning.legacy | ||
ladybug_rhino.versioning.release | ||
ladybug_rhino.versioning.userobject | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_rhino.versioning | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_rhino.versioning.userobject module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_rhino.versioning.userobject | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |