Skip to content

Commit

Permalink
deploy: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed Jul 18, 2023
0 parents commit 7b7fb1c
Show file tree
Hide file tree
Showing 140 changed files with 48,771 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: c3def9f0f2bc8b46300fadd4b6be54eb
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/cli/index.doctree
Binary file not shown.
Binary file added docs/.doctrees/cli/translate.doctree
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_radiance.cli.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/.doctrees/dragonfly_radiance.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 not shown.
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 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
977 changes: 977 additions & 0 deletions docs/_modules/dragonfly_radiance/gridpar.html

Large diffs are not rendered by default.

471 changes: 471 additions & 0 deletions docs/_modules/dragonfly_radiance/properties/building.html

Large diffs are not rendered by default.

458 changes: 458 additions & 0 deletions docs/_modules/dragonfly_radiance/properties/context.html

Large diffs are not rendered by default.

567 changes: 567 additions & 0 deletions docs/_modules/dragonfly_radiance/properties/model.html

Large diffs are not rendered by default.

543 changes: 543 additions & 0 deletions docs/_modules/dragonfly_radiance/properties/room2d.html

Large diffs are not rendered by default.

446 changes: 446 additions & 0 deletions docs/_modules/dragonfly_radiance/properties/story.html

Large diffs are not rendered by default.

330 changes: 330 additions & 0 deletions docs/_modules/index.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 ``dragonfly-radiance --help``

Commands
--------
.. toctree::
:maxdepth: 1

translate
6 changes: 6 additions & 0 deletions docs/_sources/cli/translate.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
translate
=========

.. click:: dragonfly_radiance.cli.translate:translate
:prog: dragonfly-radiance translate
:show-nested:
18 changes: 18 additions & 0 deletions docs/_sources/dragonfly_radiance.cli.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
dragonfly\_radiance.cli package
===============================

Submodules
----------

.. toctree::
:maxdepth: 4

dragonfly_radiance.cli.translate

Module contents
---------------

.. automodule:: dragonfly_radiance.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.cli.translate.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.cli.translate module
========================================

.. automodule:: dragonfly_radiance.cli.translate
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.gridpar.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.gridpar module
==================================

.. automodule:: dragonfly_radiance.gridpar
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.properties.building.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.properties.building module
==============================================

.. automodule:: dragonfly_radiance.properties.building
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.properties.context.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.properties.context module
=============================================

.. automodule:: dragonfly_radiance.properties.context
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.properties.model.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.properties.model module
===========================================

.. automodule:: dragonfly_radiance.properties.model
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.properties.room2d.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.properties.room2d module
============================================

.. automodule:: dragonfly_radiance.properties.room2d
:members:
:undoc-members:
:show-inheritance:
22 changes: 22 additions & 0 deletions docs/_sources/dragonfly_radiance.properties.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
dragonfly\_radiance.properties package
======================================

Submodules
----------

.. toctree::
:maxdepth: 4

dragonfly_radiance.properties.building
dragonfly_radiance.properties.context
dragonfly_radiance.properties.model
dragonfly_radiance.properties.room2d
dragonfly_radiance.properties.story

Module contents
---------------

.. automodule:: dragonfly_radiance.properties
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/dragonfly_radiance.properties.story.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly\_radiance.properties.story module
===========================================

.. automodule:: dragonfly_radiance.properties.story
:members:
:undoc-members:
:show-inheritance:
27 changes: 27 additions & 0 deletions docs/_sources/dragonfly_radiance.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
dragonfly\_radiance package
===========================

Subpackages
-----------

.. toctree::
:maxdepth: 4

dragonfly_radiance.cli
dragonfly_radiance.properties

Submodules
----------

.. toctree::
:maxdepth: 4

dragonfly_radiance.gridpar

Module contents
---------------

.. automodule:: dragonfly_radiance
:members:
:undoc-members:
:show-inheritance:
43 changes: 43 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
Welcome to dragonfly-radiance's documentation!
============================================

.. image:: http://www.ladybug.tools/assets/img/dragonfly.png

`Radiance <https://radiance-online.org/>`_ extension for `dragonfly <https://github.com/ladybug-tools/dragonfly-core/>`_

Dragonfly-radiance adds Radiance functionalities to dragonfly.


Installation
============

``pip install -U dragonfly-radiance``.

To check if the command line is installed correctly use ``dragonfly-radiance --help``

CLI Docs
=============

For command line interface documentation and API documentation see the pages below.


.. toctree::
:maxdepth: 2

cli/index


dragonfly_radiance
================

.. toctree::
:maxdepth: 4

modules

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
7 changes: 7 additions & 0 deletions docs/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dragonfly_radiance
==================

.. toctree::
:maxdepth: 4

dragonfly_radiance
134 changes: 134 additions & 0 deletions docs/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
/*
* _sphinx_javascript_frameworks_compat.js
* ~~~~~~~~~~
*
* Compatability shim for jQuery and underscores.js.
*
* WILL BE REMOVED IN Sphinx 6.0
* xref RemovedInSphinx60Warning
*
*/

/**
* select a different prefix for underscore
*/
$u = _.noConflict();


/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit 7b7fb1c

Please sign in to comment.