Merge pull request #15 from sdeepaknarayanan/dev5

Added HTML Documentation and Fixed Small Typo
AssembleSoftware · Jul 11, 2020 · 372a467 · 372a467
2 parents 3909bb6 + 8a542c1
commit 372a467
Show file tree

Hide file tree

Showing 123 changed files with 27,957 additions and 1 deletion.
diff --git a/IoTPy/concurrency/multicore.py b/IoTPy/concurrency/multicore.py
@@ -13,7 +13,7 @@
 if is_py2:
     import Queue as queue
 else:
-    import queue as queu
+    import queue as queue
 
 import multiprocessing
 # multiprocessing.Array provides shared memory that can

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/doctrees/IoTPy.agent_types.doctree b/docs/build/doctrees/IoTPy.agent_types.doctree
diff --git a/docs/build/doctrees/IoTPy.concurrency.doctree b/docs/build/doctrees/IoTPy.concurrency.doctree
diff --git a/docs/build/doctrees/IoTPy.core.doctree b/docs/build/doctrees/IoTPy.core.doctree
diff --git a/docs/build/doctrees/IoTPy.doctree b/docs/build/doctrees/IoTPy.doctree
diff --git a/docs/build/doctrees/IoTPy.helper_functions.doctree b/docs/build/doctrees/IoTPy.helper_functions.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.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: e0f59f5bb4d2d1a73cc759f57115267a
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/IoTPy.agent_types.html b/docs/build/html/IoTPy.agent_types.html
diff --git a/docs/build/html/IoTPy.concurrency.html b/docs/build/html/IoTPy.concurrency.html
diff --git a/docs/build/html/IoTPy.core.html b/docs/build/html/IoTPy.core.html
diff --git a/docs/build/html/IoTPy.helper_functions.html b/docs/build/html/IoTPy.helper_functions.html
diff --git a/docs/build/html/IoTPy.html b/docs/build/html/IoTPy.html
@@ -0,0 +1,266 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8">
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <title>IoTPy package &mdash; IoTPy 1.1.0 documentation</title>
+
+
+
+  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+
+
+
+
+
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+        <script src="_static/jquery.js"></script>
+        <script src="_static/underscore.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/language_data.js"></script>
+
+    <script type="text/javascript" src="_static/js/theme.js"></script>
+
+
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="index.html" class="icon icon-home" alt="Documentation Home"> IoTPy
+
+
+
+          </a>
+
+
+
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <!-- Local TOC -->
+              <div class="local-toc"><ul>
+<li><a class="reference internal" href="#">IoTPy package</a><ul>
+<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
+<li><a class="reference internal" href="#module-IoTPy">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+
+
+        </div>
+
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">IoTPy</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
+
+      <li>IoTPy package</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+
+            <a href="_sources/IoTPy.rst.txt" rel="nofollow"> View page source</a>
+
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <div class="section" id="iotpy-package">
+<h1>IoTPy package<a class="headerlink" href="#iotpy-package" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="subpackages">
+<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline">¶</a></h2>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="IoTPy.agent_types.html">IoTPy.agent_types package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.actuators_simple">IoTPy.agent_types.actuators_simple module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.basics">IoTPy.agent_types.basics module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.check_agent_parameter_types">IoTPy.agent_types.check_agent_parameter_types module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.iot">IoTPy.agent_types.iot module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.merge">IoTPy.agent_types.merge module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.multi">IoTPy.agent_types.multi module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.op">IoTPy.agent_types.op module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.sink">IoTPy.agent_types.sink module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.sliding_window_with_startup">IoTPy.agent_types.sliding_window_with_startup module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.source">IoTPy.agent_types.source module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.split">IoTPy.agent_types.split module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types.timed_agent">IoTPy.agent_types.timed_agent module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.agent_types.html#module-IoTPy.agent_types">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="IoTPy.concurrency.html">IoTPy.concurrency package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.PikaPublisher">IoTPy.concurrency.PikaPublisher module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.PikaSubscriber">IoTPy.concurrency.PikaSubscriber module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.multicore">IoTPy.concurrency.multicore module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.multithread">IoTPy.concurrency.multithread module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.pika_publication_agent">IoTPy.concurrency.pika_publication_agent module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.pika_subscribe_agent">IoTPy.concurrency.pika_subscribe_agent module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency.utils">IoTPy.concurrency.utils module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.concurrency.html#module-IoTPy.concurrency">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="IoTPy.core.html">IoTPy.core package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#module-IoTPy.core.agent">IoTPy.core.agent module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#module-IoTPy.core.compute_engine">IoTPy.core.compute_engine module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#module-IoTPy.core.helper_control">IoTPy.core.helper_control module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#module-IoTPy.core.stream">IoTPy.core.stream module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#module-IoTPy.core.system_parameters">IoTPy.core.system_parameters module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.core.html#module-IoTPy.core">Module contents</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="IoTPy.helper_functions.html">IoTPy.helper_functions package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions.Buffer">IoTPy.helper_functions.Buffer module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions.incremental_buffer">IoTPy.helper_functions.incremental_buffer module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions.json_to_csv">IoTPy.helper_functions.json_to_csv module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions.print_stream">IoTPy.helper_functions.print_stream module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions.recent_values">IoTPy.helper_functions.recent_values module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions.type">IoTPy.helper_functions.type module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="IoTPy.helper_functions.html#module-IoTPy.helper_functions">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<div class="section" id="module-IoTPy">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-IoTPy" title="Permalink to this headline">¶</a></h2>
+</div>
+</div>
+
+
+           </div>
+
+          </div>
+          <footer>
+
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+
+        &copy; Copyright 2020, K. Mani Chandy
+
+    </p>
+  </div>
+
+
+
+    Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
+
+    <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
+
+    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>