deploy: update docs

.nojekyll

@@ -0,0 +1 @@
+

README.md

@@ -0,0 +1 @@
+# documentation

docs/.buildinfo

@@ -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: 237fde2dff672e11f1b2158d32e66f6a
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/README.md

@@ -0,0 +1 @@
+# documentation

docs/_sources/cli/index.rst.txt

@@ -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

docs/_sources/cli/translate.rst.txt

@@ -0,0 +1,6 @@
+translate
+=========
+
+.. click:: dragonfly_radiance.cli.translate:translate
+ :prog: dragonfly-radiance translate
+ :show-nested:

docs/_sources/dragonfly_radiance.cli.rst.txt

@@ -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:

docs/_sources/dragonfly_radiance.cli.translate.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.cli.translate module
+========================================
+
+.. automodule:: dragonfly_radiance.cli.translate
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.gridpar.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.gridpar module
+==================================
+
+.. automodule:: dragonfly_radiance.gridpar
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.properties.building.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.building module
+==============================================
+
+.. automodule:: dragonfly_radiance.properties.building
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.properties.context.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.context module
+=============================================
+
+.. automodule:: dragonfly_radiance.properties.context
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.properties.model.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.model module
+===========================================
+
+.. automodule:: dragonfly_radiance.properties.model
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.properties.room2d.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.room2d module
+============================================
+
+.. automodule:: dragonfly_radiance.properties.room2d
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.properties.rst.txt

@@ -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:

docs/_sources/dragonfly_radiance.properties.story.rst.txt

@@ -0,0 +1,7 @@
+dragonfly\_radiance.properties.story module
+===========================================
+
+.. automodule:: dragonfly_radiance.properties.story
+ :members:
+ :undoc-members:
+ :show-inheritance:

docs/_sources/dragonfly_radiance.rst.txt

@@ -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:

docs/_sources/index.rst.txt

@@ -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`

docs/_sources/modules.rst.txt

@@ -0,0 +1,7 @@
+dragonfly_radiance
+==================
+
+.. toctree::
+ :maxdepth: 4
+
+ dragonfly_radiance

docs/_static/_sphinx_javascript_frameworks_compat.js

@@ -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;
+}