deploy: 5bdf0de

0.2.0/.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: 529c356d9b960ef9998e38fc6ad1927d
+tags: 645f666f9bcd5a90fca523b33c5a78b7

0.2.0/_sources/explanations.rst.txt

@@ -0,0 +1,11 @@
+:orphan:
+
+Explanations
+============
+
+Explanation of how the library works and why it works that way.
+
+.. toctree::
+    :caption: Explanations
+
+    explanations/todo

0.2.0/_sources/explanations/todo.rst.txt

@@ -0,0 +1,4 @@
+Explanations
+============
+
+Todo

0.2.0/_sources/how-to.rst.txt

@@ -0,0 +1,11 @@
+:orphan:
+
+How-to Guides
+=============
+
+Practical step-by-step guides for the more experienced user.
+
+.. toctree::
+    :caption: How-to Guides
+
+    how-to/todo

0.2.0/_sources/how-to/todo.rst.txt

@@ -0,0 +1,4 @@
+How To
+======
+
+Todo

0.2.0/_sources/index.rst.txt

@@ -0,0 +1,48 @@
+.. include:: ../README.rst
+    :end-before: when included in index.rst
+
+
+How the documentation is structured
+-----------------------------------
+
+Documentation is split into four categories, also accessible from links in the
+side-bar.
+
+.. rst-class:: columns
+
+`tutorials`
+~~~~~~~~~~~
+
+.. include:: tutorials.rst
+    :start-after: =========
+
+.. rst-class:: columns
+
+`how-to`
+~~~~~~~~
+
+.. include:: how-to.rst
+    :start-after: =============
+
+.. rst-class:: columns
+
+`explanations`
+~~~~~~~~~~~~~~
+
+.. include:: explanations.rst
+    :start-after: ============
+
+.. rst-class:: columns
+
+`reference`
+~~~~~~~~~~~
+
+.. include:: reference.rst
+    :start-after: =========
+
+.. rst-class:: endcolumns
+
+About the documentation
+~~~~~~~~~~~~~~~~~~~~~~~
+
+`Why is the documentation structured this way? <https://documentation.divio.com>`_

0.2.0/_sources/reference.rst.txt

@@ -0,0 +1,18 @@
+:orphan:
+
+Reference
+=========
+
+Practical step-by-step guides for the more experienced user.
+
+.. toctree::
+    :caption: Reference
+
+    reference/api
+    reference/contributing
+    Releases <https://github.com/epics-containers/builder2ibek/releases>
+    Index <genindex.html#http://>
+
+..
+    Index link above is a hack to make genindex.html a relative link
+    https://stackoverflow.com/a/31820846

0.2.0/_sources/reference/api.rst.txt

@@ -0,0 +1,17 @@
+API
+===
+
+This is the internal API reference for ibek
+
+
+.. automodule ibek
+
+``ibek``
+~~~~~~~~
+
+.. data:: ibek.__version__
+    :type: str
+
+    Version number as calculated by setuptools_scm
+
+

0.2.0/_sources/reference/contributing.rst.txt

@@ -0,0 +1 @@
+.. include:: ../../CONTRIBUTING.rst

0.2.0/_sources/tutorials.rst.txt

@@ -0,0 +1,11 @@
+:orphan:
+
+Tutorials
+=========
+
+Tutorials for installation, library and commandline usage. New users start here.
+
+.. toctree::
+    :caption: Tutorials
+
+    tutorials/installation

0.2.0/_sources/tutorials/installation.rst.txt

@@ -0,0 +1,47 @@
+Installation
+============
+
+.. note::
+
+    For installation inside DLS, please see the internal documentation on
+    ``dls-python3`` and ``pipenv``. Although these instructions will work
+    inside DLS, they are intended for external use.
+
+    If you want to contribute to the library itself, please follow
+    the `../reference/contributing` instructions.
+
+
+Check your version of python
+----------------------------
+
+You will need python 3.7 or later. You can check your version of python by
+typing into a terminal::
+
+    python3 --version
+
+Create a virtual environment
+----------------------------
+
+It is recommended that you install into a “virtual environment” so this
+installation will not interfere with any existing Python software::
+
+    python3 -m venv /path/to/venv
+    source /path/to/venv/bin/activate
+
+
+Installing the library
+----------------------
+
+You can now use ``pip`` to install the library::
+
+    python3 -m pip install builder2ibek
+
+If you require a feature that is not currently released you can also install
+from github::
+
+    python3 -m pip install git+git://github.com/epics-containers/builder2ibek.git
+
+The library should now be installed and the commandline interface on your path.
+You can check the version that has been installed by typing::
+
+    builder2ibek --version

0.2.0/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * 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;
+}