Docs

- uploading new docs
carlkidcrypto · Jan 5, 2024 · 2a60aae · 2a60aae
1 parent c2949da
commit 2a60aae
Show file tree

Hide file tree

Showing 29 changed files with 252 additions and 187 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@
 **/purpleair_api.egg-info/**
 test/.coverage
 test/coverage_reports/**
+**/.DS_Store
diff --git a/docs/doctrees/PurpleAirAPI.doctree b/docs/doctrees/PurpleAirAPI.doctree
diff --git a/docs/doctrees/PurpleAirAPIConstants.doctree b/docs/doctrees/PurpleAirAPIConstants.doctree
diff --git a/docs/doctrees/PurpleAirAPIError.doctree b/docs/doctrees/PurpleAirAPIError.doctree
diff --git a/docs/doctrees/PurpleAirAPIHelpers.doctree b/docs/doctrees/PurpleAirAPIHelpers.doctree
diff --git a/docs/doctrees/PurpleAirLocalAPI.doctree b/docs/doctrees/PurpleAirLocalAPI.doctree
diff --git a/docs/doctrees/PurpleAirReadAPI.doctree b/docs/doctrees/PurpleAirReadAPI.doctree
diff --git a/docs/doctrees/PurpleAirWriteAPI.doctree b/docs/doctrees/PurpleAirWriteAPI.doctree
diff --git a/docs/doctrees/environment.pickle b/docs/doctrees/environment.pickle
diff --git a/docs/doctrees/index.doctree b/docs/doctrees/index.doctree
diff --git a/docs/doctrees/modules.doctree b/docs/doctrees/modules.doctree
diff --git a/docs/html/PurpleAirAPI.html b/docs/html/PurpleAirAPI.html
@@ -1,21 +1,23 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirAPI module &mdash; PurpleAir API V1.1.2 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirAPI module &mdash; PurpleAir API V1.1.3 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=b405dd7c"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -90,31 +92,31 @@
            <div itemprop="articleBody">
 
   <section id="module-PurpleAirAPI">
-<span id="purpleairapi-module"></span><h1>PurpleAirAPI module<a class="headerlink" href="#module-PurpleAirAPI" title="Permalink to this heading"></a></h1>
+<span id="purpleairapi-module"></span><h1>PurpleAirAPI module<a class="headerlink" href="#module-PurpleAirAPI" title="Link to this heading"></a></h1>
 <p>Copyright 2023 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>
 <dl class="py class">
 <dt class="sig sig-object py" id="PurpleAirAPI.PurpleAirAPI">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirAPI.</span></span><span class="sig-name descname"><span class="pre">PurpleAirAPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">your_api_read_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">your_api_write_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">your_ipv4_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirAPI.</span></span><span class="sig-name descname"><span class="pre">PurpleAirAPI</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">your_api_read_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">your_api_write_key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">your_ipv4_address</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">PurpleAirReadAPI</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">PurpleAirWriteAPI</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">PurpleAirLocalAPI</span></code></p>
 <p>The PurpleAirAPI class designed to send valid
 PurpleAirAPI requests.</p>
 <dl class="py property">
 <dt class="sig sig-object py" id="PurpleAirAPI.PurpleAirAPI.get_api_key_last_checked">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_api_key_last_checked</span></span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI.get_api_key_last_checked" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_api_key_last_checked</span></span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI.get_api_key_last_checked" title="Link to this definition"></a></dt>
 <dd><p>A method to return the timestamp of when the API read/write keys were last checked.</p>
 </dd></dl>
 
 <dl class="py property">
 <dt class="sig sig-object py" id="PurpleAirAPI.PurpleAirAPI.get_api_key_type">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_api_key_type</span></span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI.get_api_key_type" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_api_key_type</span></span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI.get_api_key_type" title="Link to this definition"></a></dt>
 <dd><p>A method to return the API key types being used.</p>
 </dd></dl>
 
 <dl class="py property">
 <dt class="sig sig-object py" id="PurpleAirAPI.PurpleAirAPI.get_api_versions">
-<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_api_versions</span></span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI.get_api_versions" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_api_versions</span></span><a class="headerlink" href="#PurpleAirAPI.PurpleAirAPI.get_api_versions" title="Link to this definition"></a></dt>
 <dd><p>A method to return the API versions being used for both read/write keys.</p>
 </dd></dl>
 
@@ -133,7 +135,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/html/PurpleAirAPIConstants.html b/docs/html/PurpleAirAPIConstants.html
diff --git a/docs/html/PurpleAirAPIError.html b/docs/html/PurpleAirAPIError.html
@@ -1,21 +1,23 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>PurpleAirAPIError module &mdash; PurpleAir API V1.1.2 documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>PurpleAirAPIError module &mdash; PurpleAir API V1.1.3 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+
+
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=b405dd7c"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
@@ -85,13 +87,13 @@
            <div itemprop="articleBody">
 
   <section id="module-PurpleAirAPIError">
-<span id="purpleairapierror-module"></span><h1>PurpleAirAPIError module<a class="headerlink" href="#module-PurpleAirAPIError" title="Permalink to this heading"></a></h1>
+<span id="purpleairapierror-module"></span><h1>PurpleAirAPIError module<a class="headerlink" href="#module-PurpleAirAPIError" title="Link to this heading"></a></h1>
 <p>Copyright 2023 carlkidcrypto, All rights reserved.
 A python3 class designed to fetch data from Purple Air’s new API.
 <a class="reference external" href="https://api.purpleair.com/#api-welcome">https://api.purpleair.com/#api-welcome</a></p>
 <dl class="py exception">
 <dt class="sig sig-object py" id="PurpleAirAPIError.PurpleAirAPIError">
-<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirAPIError.</span></span><span class="sig-name descname"><span class="pre">PurpleAirAPIError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirAPIError.PurpleAirAPIError" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">PurpleAirAPIError.</span></span><span class="sig-name descname"><span class="pre">PurpleAirAPIError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_string</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#PurpleAirAPIError.PurpleAirAPIError" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
 <p>Custom Exception for our PurpleAirAPI class.</p>
 </dd></dl>
@@ -109,7 +111,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2023, carlkidcrypto.</p>
+    <p>&#169; Copyright 2024, carlkidcrypto.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a