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 11, 2024
0 parents commit edcd05d
Show file tree
Hide file tree
Showing 232 changed files with 91,821 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: 40af715a0db8e7637cf7a273aeb72f46
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/cli/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/main.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 not shown.
Binary file added docs/.doctrees/ladybug_rhino.bakegeometry.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.bakeobjects.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.cli.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.color.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.colorize.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.command.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.config.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.download.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.fromgeometry.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.fromobjects.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.ghpath.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.grasshopper.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.intersect.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.light.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.planarize.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.preview.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.pythonpath.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.resourcepath.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.text.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.togeometry.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.versioning.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_rhino.viewport.doctree
Binary file not shown.
Binary file added docs/.doctrees/ladybug_rhino.visset.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
683 changes: 683 additions & 0 deletions docs/_modules/index.html

Large diffs are not rendered by default.

965 changes: 965 additions & 0 deletions docs/_modules/ladybug_rhino/bakedisplay.html

Large diffs are not rendered by default.

1,000 changes: 1,000 additions & 0 deletions docs/_modules/ladybug_rhino/bakegeometry.html

Large diffs are not rendered by default.

939 changes: 939 additions & 0 deletions docs/_modules/ladybug_rhino/bakeobjects.html

Large diffs are not rendered by default.

700 changes: 700 additions & 0 deletions docs/_modules/ladybug_rhino/color.html

Large diffs are not rendered by default.

931 changes: 931 additions & 0 deletions docs/_modules/ladybug_rhino/colorize.html

Large diffs are not rendered by default.

1,464 changes: 1,464 additions & 0 deletions docs/_modules/ladybug_rhino/command.html

Large diffs are not rendered by default.

830 changes: 830 additions & 0 deletions docs/_modules/ladybug_rhino/config.html

Large diffs are not rendered by default.

828 changes: 828 additions & 0 deletions docs/_modules/ladybug_rhino/download.html

Large diffs are not rendered by default.

1,122 changes: 1,122 additions & 0 deletions docs/_modules/ladybug_rhino/fromgeometry.html

Large diffs are not rendered by default.

852 changes: 852 additions & 0 deletions docs/_modules/ladybug_rhino/fromobjects.html

Large diffs are not rendered by default.

806 changes: 806 additions & 0 deletions docs/_modules/ladybug_rhino/ghpath.html

Large diffs are not rendered by default.

1,288 changes: 1,288 additions & 0 deletions docs/_modules/ladybug_rhino/grasshopper.html

Large diffs are not rendered by default.

1,581 changes: 1,581 additions & 0 deletions docs/_modules/ladybug_rhino/intersect.html

Large diffs are not rendered by default.

769 changes: 769 additions & 0 deletions docs/_modules/ladybug_rhino/light.html

Large diffs are not rendered by default.

831 changes: 831 additions & 0 deletions docs/_modules/ladybug_rhino/openstudio.html

Large diffs are not rendered by default.

858 changes: 858 additions & 0 deletions docs/_modules/ladybug_rhino/planarize.html

Large diffs are not rendered by default.

1,561 changes: 1,561 additions & 0 deletions docs/_modules/ladybug_rhino/preview.html

Large diffs are not rendered by default.

1,001 changes: 1,001 additions & 0 deletions docs/_modules/ladybug_rhino/pythonpath.html

Large diffs are not rendered by default.

700 changes: 700 additions & 0 deletions docs/_modules/ladybug_rhino/resourcepath.html

Large diffs are not rendered by default.

920 changes: 920 additions & 0 deletions docs/_modules/ladybug_rhino/text.html

Large diffs are not rendered by default.

1,092 changes: 1,092 additions & 0 deletions docs/_modules/ladybug_rhino/togeometry.html

Large diffs are not rendered by default.

1,121 changes: 1,121 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/change.html

Large diffs are not rendered by default.

879 changes: 879 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/component.html

Large diffs are not rendered by default.

975 changes: 975 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/diff.html

Large diffs are not rendered by default.

1,009 changes: 1,009 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/export.html

Large diffs are not rendered by default.

880 changes: 880 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/gather.html

Large diffs are not rendered by default.

1,190 changes: 1,190 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/legacy.html

Large diffs are not rendered by default.

699 changes: 699 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/release.html

Large diffs are not rendered by default.

754 changes: 754 additions & 0 deletions docs/_modules/ladybug_rhino/versioning/userobject.html

Large diffs are not rendered by default.

1,010 changes: 1,010 additions & 0 deletions docs/_modules/ladybug_rhino/viewport.html

Large diffs are not rendered by default.

741 changes: 741 additions & 0 deletions docs/_modules/ladybug_rhino/visset.html

Large diffs are not rendered by default.

14 changes: 14 additions & 0 deletions docs/_sources/cli/index.rst.txt
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
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:: 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
44 changes: 44 additions & 0 deletions docs/_sources/index.rst.txt
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`
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.bakedisplay.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.bakegeometry.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.bakeobjects.rst.txt
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:
10 changes: 10 additions & 0 deletions docs/_sources/ladybug_rhino.cli.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.color.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.colorize.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.command.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.config.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.download.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.fromgeometry.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.fromobjects.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.ghpath.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.grasshopper.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.intersect.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.light.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.openstudio.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.planarize.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.preview.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.pythonpath.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.resourcepath.rst.txt
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:
49 changes: 49 additions & 0 deletions docs/_sources/ladybug_rhino.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.text.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.togeometry.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.change.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.component.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.diff.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.export.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.gather.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.legacy.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.release.rst.txt
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:
25 changes: 25 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.rst.txt
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:
7 changes: 7 additions & 0 deletions docs/_sources/ladybug_rhino.versioning.userobject.rst.txt
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:
Loading

0 comments on commit edcd05d

Please sign in to comment.