-
Notifications
You must be signed in to change notification settings - Fork 1
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: ad4dd8ac9d5cf803d3debe990a6d2bec | ||
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.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
CLI Docs | ||
======== | ||
|
||
Installation | ||
------------ | ||
|
||
To check if the command line is installed correctly use ``ladybug-display --help`` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
Welcome to ladybug-display's documentation! | ||
=================================== | ||
|
||
A library that assigns basic display attributes to ladybug-geometry objects (color, line weight, line type, etc). | ||
|
||
|
||
Installation | ||
============ | ||
|
||
``pip install ladybug-display`` | ||
|
||
|
||
ladybug-display | ||
======= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
.. include:: modules.rst | ||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.altnumber module | ||
================================= | ||
|
||
.. automodule:: ladybug_display.altnumber | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.dictutil module | ||
================================ | ||
|
||
.. automodule:: ladybug_display.dictutil | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.adaptivechart module | ||
=============================================== | ||
|
||
.. automodule:: ladybug_display.extension.adaptivechart | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.compass module | ||
========================================= | ||
|
||
.. automodule:: ladybug_display.extension.compass | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.hourlyplot module | ||
============================================ | ||
|
||
.. automodule:: ladybug_display.extension.hourlyplot | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.monthlychart module | ||
============================================== | ||
|
||
.. automodule:: ladybug_display.extension.monthlychart | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.psychchart module | ||
============================================ | ||
|
||
.. automodule:: ladybug_display.extension.psychchart | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.raddome module | ||
========================================= | ||
|
||
.. automodule:: ladybug_display.extension.raddome | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.radrose module | ||
========================================= | ||
|
||
.. automodule:: ladybug_display.extension.radrose | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
ladybug\_display.extension package | ||
================================== | ||
|
||
Subpackages | ||
----------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_display.extension.study | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_display.extension.adaptivechart | ||
ladybug_display.extension.compass | ||
ladybug_display.extension.hourlyplot | ||
ladybug_display.extension.monthlychart | ||
ladybug_display.extension.psychchart | ||
ladybug_display.extension.raddome | ||
ladybug_display.extension.radrose | ||
ladybug_display.extension.skydome | ||
ladybug_display.extension.sunpath | ||
ladybug_display.extension.windprofile | ||
ladybug_display.extension.windrose | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_display.extension | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.skydome module | ||
========================================= | ||
|
||
.. automodule:: ladybug_display.extension.skydome | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.study.directsun module | ||
================================================= | ||
|
||
.. automodule:: ladybug_display.extension.study.directsun | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.study.radiation module | ||
================================================= | ||
|
||
.. automodule:: ladybug_display.extension.study.radiation | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
ladybug\_display.extension.study package | ||
======================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_display.extension.study.directsun | ||
ladybug_display.extension.study.radiation | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_display.extension.study | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.sunpath module | ||
========================================= | ||
|
||
.. automodule:: ladybug_display.extension.sunpath | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.windprofile module | ||
============================================= | ||
|
||
.. automodule:: ladybug_display.extension.windprofile | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.extension.windrose module | ||
========================================== | ||
|
||
.. automodule:: ladybug_display.extension.windrose | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.arc module | ||
====================================== | ||
|
||
.. automodule:: ladybug_display.geometry2d.arc | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.line module | ||
======================================= | ||
|
||
.. automodule:: ladybug_display.geometry2d.line | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.mesh module | ||
======================================= | ||
|
||
.. automodule:: ladybug_display.geometry2d.mesh | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.point module | ||
======================================== | ||
|
||
.. automodule:: ladybug_display.geometry2d.point | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.polygon module | ||
========================================== | ||
|
||
.. automodule:: ladybug_display.geometry2d.polygon | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.polyline module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_display.geometry2d.polyline | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.ray module | ||
====================================== | ||
|
||
.. automodule:: ladybug_display.geometry2d.ray | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
ladybug\_display.geometry2d package | ||
=================================== | ||
|
||
Submodules | ||
---------- | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
ladybug_display.geometry2d.arc | ||
ladybug_display.geometry2d.line | ||
ladybug_display.geometry2d.mesh | ||
ladybug_display.geometry2d.point | ||
ladybug_display.geometry2d.polygon | ||
ladybug_display.geometry2d.polyline | ||
ladybug_display.geometry2d.ray | ||
ladybug_display.geometry2d.vector | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: ladybug_display.geometry2d | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry2d.vector module | ||
========================================= | ||
|
||
.. automodule:: ladybug_display.geometry2d.vector | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.arc module | ||
====================================== | ||
|
||
.. automodule:: ladybug_display.geometry3d.arc | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.cone module | ||
======================================= | ||
|
||
.. automodule:: ladybug_display.geometry3d.cone | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.cylinder module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_display.geometry3d.cylinder | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.face module | ||
======================================= | ||
|
||
.. automodule:: ladybug_display.geometry3d.face | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.line module | ||
======================================= | ||
|
||
.. automodule:: ladybug_display.geometry3d.line | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.mesh module | ||
======================================= | ||
|
||
.. automodule:: ladybug_display.geometry3d.mesh | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.plane module | ||
======================================== | ||
|
||
.. automodule:: ladybug_display.geometry3d.plane | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.point module | ||
======================================== | ||
|
||
.. automodule:: ladybug_display.geometry3d.point | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.polyface module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_display.geometry3d.polyface | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ladybug\_display.geometry3d.polyline module | ||
=========================================== | ||
|
||
.. automodule:: ladybug_display.geometry3d.polyline | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |