Added sphinx documentation (to be tested with readthedocs)

docs/build/html/_sources/mbtrack2.tracking.rst.txt

+mbtrack2.tracking package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   mbtrack2.tracking.monitors
+
+Submodules
+----------
+
+mbtrack2.tracking.aperture module
+---------------------------------
+
+.. automodule:: mbtrack2.tracking.aperture
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.element module
+--------------------------------
+
+.. automodule:: mbtrack2.tracking.element
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.feedback module
+---------------------------------
+
+.. automodule:: mbtrack2.tracking.feedback
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.parallel module
+---------------------------------
+
+.. automodule:: mbtrack2.tracking.parallel
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.particles module
+----------------------------------
+
+.. automodule:: mbtrack2.tracking.particles
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.rf module
+---------------------------
+
+.. automodule:: mbtrack2.tracking.rf
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.synchrotron module
+------------------------------------
+
+.. automodule:: mbtrack2.tracking.synchrotron
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.tracking.wakepotential module
+--------------------------------------
+
+.. automodule:: mbtrack2.tracking.wakepotential
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: mbtrack2.tracking
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_sources/mbtrack2.utilities.rst.txt

+mbtrack2.utilities package
+==========================
+
+Submodules
+----------
+
+mbtrack2.utilities.beamloading module
+-------------------------------------
+
+.. automodule:: mbtrack2.utilities.beamloading
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.utilities.misc module
+------------------------------
+
+.. automodule:: mbtrack2.utilities.misc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.utilities.optics module
+--------------------------------
+
+.. automodule:: mbtrack2.utilities.optics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.utilities.read\_impedance module
+-----------------------------------------
+
+.. automodule:: mbtrack2.utilities.read_impedance
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+mbtrack2.utilities.spectrum module
+----------------------------------
+
+.. automodule:: mbtrack2.utilities.spectrum
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: mbtrack2.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/build/html/_static/_sphinx_javascript_frameworks_compat.js

+/*
+ * _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;
+}

docs/build/html/_static/documentation_options.js

+var DOCUMENTATION_OPTIONS = {
+    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+    VERSION: '0.6.0',
+    LANGUAGE: 'en',
+    COLLAPSE_INDEX: false,
+    BUILDER: 'html',
+    FILE_SUFFIX: '.html',
+    LINK_SUFFIX: '.html',
+    HAS_SOURCE: true,
+    SOURCELINK_SUFFIX: '.txt',
+    NAVIGATION_WITH_KEYS: false,
+    SHOW_SEARCH_SUMMARY: true,
+    ENABLE_SEARCH_SHORTCUTS: false,
+};
\ No newline at end of file