Updating Docs for commit 4b977b9 made on 2024-12-20T16:11:43+00:00 fr…

…om refs/heads/main by ZanSara

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 17f0c7a22566302b074050ce610a8ce6
+tags: 645f666f9bcd5a90fca523b33c5a78b7

README.md

@@ -0,0 +1,7 @@
+
+# zanzocam-core - Internal Documentation Build Artifacts
+
+Nothing to see here. The content of this branch is essentially a cache for build artifacts.
+
+If you are looking for the documentation, check the relevant development branch's 'docs/' directory.
+

_sources/index.rst.txt

@@ -0,0 +1,112 @@
+ZanzoCam - Internal documentation
+=================================
+
+Internal documentation for ``zanzocam-core``.
+
+Better documentation coming soon.
+
+..
+      Indices and tables
+      ------------------
+
+      * :ref:`genindex`
+      * :ref:`modindex`
+      * :ref:`search`
+
+
+--------------------
+
+
+Constants
+---------
+
+Details of the constants stored in the ``zanzocam.constants`` module.
+
+.. automodule:: zanzocam.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+--------------------
+
+
+Main module
+-----------
+
+The ``zanzocam.webcam.main`` module contains the main script that is 
+executed at every trigger.
+
+Here is some internal documentation of it.
+
+.. automodule:: zanzocam.webcam.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Configuration module
+--------------------
+
+Details of the ``zanzocam.webcam.configuration`` module.
+
+
+.. automodule:: zanzocam.webcam.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+System module
+-------------
+
+Details of the ``zanzocam.webcam.system`` module.
+
+.. automodule:: zanzocam.webcam.system
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Camera module
+-------------
+
+Details of the ``zanzocam.webcam.camera`` module.
+
+.. automodule:: zanzocam.webcam.camera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Overlays module
+---------------
+
+Details of the ``zanzocam.webcam.overlays`` module.
+
+.. automodule:: zanzocam.webcam.overlays
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Utils module
+------------
+
+Details of the ``zanzocam.webcam.utils`` module.
+
+.. automodule:: zanzocam.webcam.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Custom Errors
+-------------
+
+Details of the ``zanzocam.webcam.errors`` module.
+
+.. automodule:: zanzocam.webcam.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:

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