Skip to content

Commit

Permalink
deploy: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chriswmackey committed Dec 13, 2023
0 parents commit e27a134
Show file tree
Hide file tree
Showing 120 changed files with 42,586 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
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: 6d696cc953330ae958c556728bc97198
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 added docs/.doctrees/lbt_recipes.cli.doctree
Binary file not shown.
Binary file added docs/.doctrees/lbt_recipes.doctree
Binary file not shown.
Binary file added docs/.doctrees/lbt_recipes.recipe.doctree
Binary file not shown.
Binary file added docs/.doctrees/lbt_recipes.settings.doctree
Binary file not shown.
Binary file added docs/.doctrees/lbt_recipes.version.doctree
Binary file not shown.
Binary file added docs/.doctrees/modules.doctree
Binary file not shown.
Empty file added docs/.nojekyll
Empty file.
241 changes: 241 additions & 0 deletions docs/_modules/index.html

Large diffs are not rendered by default.

856 changes: 856 additions & 0 deletions docs/_modules/lbt_recipes/recipe.html

Large diffs are not rendered by default.

429 changes: 429 additions & 0 deletions docs/_modules/lbt_recipes/settings.html

Large diffs are not rendered by default.

324 changes: 324 additions & 0 deletions docs/_modules/lbt_recipes/version.html

Large diffs are not rendered by default.

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


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:: lbt_recipes.cli.__init__:main
:prog: lbt-recipes
:show-nested:
:commands: run ,viz
42 changes: 42 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
Welcome to lbt-recipes' documentation!
=======================================

A collection of recipes that ship with the Ladybug Tools plugins.

This includes Radiance recipes, which automate the process of running daylight and radiation studies using `Radiance <https://radiance-online.org/>`_.

It also includes microclimate mapping recipes, which spatially map thermal comfort using `EnergyPlus <https://github.com/NREL/EnergyPlus/>`_ and `Radiance <https://radiance-online.org/>`_.

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

To install the library use ``pip install -U lbt-recipes``.

To check if the command line interface is installed correctly use ``lbt-recipes viz`` and you
should get a ``viiiiiiiiiiiiizzzzzzzzz!`` back in response!

CLI Docs
========

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

.. toctree::
:maxdepth: 2

cli//index


lbt_recipes
=============

.. toctree::
:maxdepth: 4

modules

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

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
10 changes: 10 additions & 0 deletions docs/_sources/lbt_recipes.cli.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
lbt\_recipes.cli package
========================

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

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

.. automodule:: lbt_recipes.recipe
:members:
:undoc-members:
:show-inheritance:
28 changes: 28 additions & 0 deletions docs/_sources/lbt_recipes.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
lbt\_recipes package
====================

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

.. toctree::
:maxdepth: 4

lbt_recipes.cli

Submodules
----------

.. toctree::
:maxdepth: 4

lbt_recipes.recipe
lbt_recipes.settings
lbt_recipes.version

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

.. automodule:: lbt_recipes
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/lbt_recipes.settings.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
lbt\_recipes.settings module
============================

.. automodule:: lbt_recipes.settings
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/_sources/lbt_recipes.version.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
lbt\_recipes.version module
===========================

.. automodule:: lbt_recipes.version
:members:
:undoc-members:
:show-inheritance:
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 @@
lbt_recipes
===========

.. toctree::
:maxdepth: 4

lbt_recipes
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 e27a134

Please sign in to comment.