Skip to content

Commit

Permalink
updates documentation bugfixes for v3.3
Browse files Browse the repository at this point in the history
  • Loading branch information
sud335 committed Sep 28, 2022
1 parent c663e94 commit 8c44d9f
Show file tree
Hide file tree
Showing 75 changed files with 23,658 additions and 10,347 deletions.
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 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 not shown.
Binary file modified buildingdepot/Documentation/build/doctrees/dataservice.doctree
Binary file not shown.
Binary file modified buildingdepot/Documentation/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified buildingdepot/Documentation/build/doctrees/index.doctree
Binary file not shown.
Binary file modified buildingdepot/Documentation/build/doctrees/install.doctree
Binary file not shown.
Binary file modified buildingdepot/Documentation/build/doctrees/source/index.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion buildingdepot/Documentation/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: c6a7958682c2949e04c6169ca87cceed
config: baa4009e8e8e1b43577fb95ae5d5bf07
tags: 645f666f9bcd5a90fca523b33c5a78b7
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ This request retrieves name, description and template to used in the building sp
"Room": [],
"corridor": ["floor"],
"floor": []
},
},
"tags": [
{ "value": "1",
"parents": [],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Generating access tokens
Generate an access token using the client id and secret key obtained from the CentralService. Each access token is valid for 24 hours from the time of generation.

.. http:get:: /oauth/access_token/client_id=<client_id>/client_secret=<client_secret>
:returns:
* **access token**
:returns:
* **access token**

.. compound::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Generating access tokens
Generate an access token using the client id and secret key obtained from the CentralService. Each access token is valid for 24 hours from the time of generation.

.. http:get:: /oauth/access_token/client_id=<client_id>/client_secret=<client_secret>
:returns:
* **access token**
:returns:
* **access token**

.. compound::

Expand Down
8 changes: 4 additions & 4 deletions buildingdepot/Documentation/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. BuildingDepot 3.2.9 documentation master file.
.. BuildingDepot 3.3 documentation master file.
=====================
Building Depot v3.2.9
Building Depot v3.3
=====================

Overview
########

This is the official documentation of BuildingDepot v3.2.9. BuildingDepot is essentialy an Extensible and Distributed Architecture for Sensor Data Storage, Access and Sharing.
This is the official documentation of BuildingDepot v3.3. BuildingDepot is essentialy an Extensible and Distributed Architecture for Sensor Data Storage, Access and Sharing.


Building Depot has two essential components a Central Service and a Data Service :
Expand Down Expand Up @@ -44,7 +44,7 @@ Read more about the DataService
Download
########

You can get the latest BuildingDepot package (tar.gz) from `buildingdepot.org <https://iotexpedition.org/software/BuildingDepot-v3.2.7.tar.gz>`_
You can get the latest BuildingDepot package (tar.gz) from `buildingdepot.org <https://iotexpedition.org/software/BuildingDepot-v3-3.2.9.zip>`_

Install
#######
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. BuildingDepot v3.2.9 documentation master file, created by
sphinx-quickstart on Mon Feb 24 20:13:25 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
sphinx-quickstart on Mon Feb 24 20:13:25 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to BuildingDepot v3.2.9's documentation!
================================================
Expand Down
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 8c44d9f

Please sign in to comment.