Skip to content

Commit

Permalink
various fixes to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mccroweyclinton-EPA committed Oct 24, 2024
1 parent 85d3ad7 commit 74aea23
Show file tree
Hide file tree
Showing 41 changed files with 44 additions and 126 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ help:
# 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) -W -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -W -vvv
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/EPA_Disclaimer.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/Install_pyaqsapi.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/Introduction.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/Load_pyaqsapi.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/RAQSAPI.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/TimelinessofAQSdata.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/Troubleshooting.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/Using_pyaqsapi.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/pyaqsapiFunctions-Brief.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/manual/pyaqsapiFunctions-Long.doctree
Binary file not shown.
Binary file not shown.
1 change: 0 additions & 1 deletion docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ pyaqsapi API reference documentation

pyaqsapi index
--------------

* :ref:`genindex`

References
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/EPA_Disclaimer.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: EPA Disclaimer
.. index:: EPA Disclaimer;

EPA Disclaimer
==============
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/Install_pyaqsapi.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Install pyaqsapi
.. index:: Install pyaqsapi;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Install pyaqsapi
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/Introduction.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Introduction
.. index:: Introduction;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Introduction
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/Load_pyaqsapi.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Load pyaqsapi
.. index:: Load pyaqsapi;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Load pyaqsapi
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/RAQSAPI.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: About RAQSAPI
.. index:: About RAQSAPI;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

About RAQSAPI
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/TimelinessofAQSdata.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: About the timeliness of AQS Data
.. index:: About the timeliness of AQS;

About the timeliness of AQS Data
================================
Expand Down
4 changes: 1 addition & 3 deletions docs/_build/html/_sources/manual/Troubleshooting.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Troubleshooting pyaqsapi
.. index:: Troubleshooting pyaqsapi;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Troubleshooting
Expand Down
6 changes: 2 additions & 4 deletions docs/_build/html/_sources/manual/Using_pyaqsapi.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Using pyaqsapi
.. index:: Using pyaqsapi;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Using pyaqsapi
Expand All @@ -17,7 +15,7 @@ AQSAPI_V2 python 3 objects are returned. Use the get_data() class method to
retrieve the data and the get_header() class method to retrieve header
information.

.. index:: sign_up
.. index:: sign_up;

Sign up and setting up user credentials with the pyaqsapi library
=================================================================
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:orphan:

.. index:: pyaqsapi Functions Brief
.. index:: pyaqsapi Functions Brief;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Data Mart aggregate functions
Expand All @@ -16,7 +16,7 @@ These functions retrieve aggregated data from the Data Mart API and are grouped
by how each function aggregates the data. There are 7 different families of
related aggregate functions in which the AQS Data Mart API groups data.

.. index:: aggregate functions
.. index:: aggregate functions;

These seven families are:

Expand All @@ -33,7 +33,7 @@ Within these families of aggregated data functions there are functions that
call on the 13 different aggregate services that the Data Mart API provides.
Note that not all aggregations are available for each service.

.. index:: services
.. index:: services;

These thirteen services are:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: pyaqsapi Functions Long
.. index:: pyaqsapi Functions Long;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Functions Exported by pyaqsapi
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Useage tips and precuations
.. index:: Useage tips and precuations;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Usage tips and precautions
Expand Down
28 changes: 14 additions & 14 deletions docs/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ <h1 id="index">Index</h1>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-10">About RAQSAPI</a>, <a href="manual/RAQSAPI.html#index-0">[1]</a>
<li><a href="index.html#index-10">About RAQSAPI;</a>, <a href="manual/RAQSAPI.html#index-0">[1]</a>
</li>
<li><a href="index.html#index-2">About the timeliness of AQS Data</a>, <a href="manual/TimelinessofAQSdata.html#index-0">[1]</a>
<li><a href="index.html#index-2">About the timeliness of AQS;</a>, <a href="manual/TimelinessofAQSdata.html#index-0">[1]</a>
</li>
<li><a href="manual/pyaqsapiFunctions-Brief.html#index-1">aggregate functions</a>
<li><a href="manual/pyaqsapiFunctions-Brief.html#index-1">aggregate functions;</a>
</li>
<li><a href="pyaqsapi.bybox.html#pyaqsapi.bybox.annualsummary">annualsummary() (in module pyaqsapi.bybox)</a>

Expand Down Expand Up @@ -193,7 +193,7 @@ <h2 id="D">D</h2>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-0">EPA Disclaimer</a>, <a href="manual/EPA_Disclaimer.html#index-0">[1]</a>
<li><a href="index.html#index-0">EPA Disclaimer;</a>, <a href="manual/EPA_Disclaimer.html#index-0">[1]</a>
</li>
</ul></td>
</tr></table>
Expand All @@ -219,19 +219,19 @@ <h2 id="G">G</h2>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-3">Install pyaqsapi</a>, <a href="manual/Install_pyaqsapi.html#index-0">[1]</a>
<li><a href="index.html#index-3">Install pyaqsapi;</a>, <a href="manual/Install_pyaqsapi.html#index-0">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-1">Introduction</a>, <a href="manual/Introduction.html#index-0">[1]</a>
<li><a href="index.html#index-1">Introduction;</a>, <a href="manual/Introduction.html#index-0">[1]</a>
</li>
</ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-4">Load pyaqsapi</a>, <a href="manual/Load_pyaqsapi.html#index-0">[1]</a>
<li><a href="index.html#index-4">Load pyaqsapi;</a>, <a href="manual/Load_pyaqsapi.html#index-0">[1]</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -319,9 +319,9 @@ <h2 id="P">P</h2>
<li><a href="pyaqsapi.html#module-pyaqsapi">module</a>
</li>
</ul></li>
<li><a href="manual/pyaqsapiFunctions-Brief.html#index-0">pyaqsapi Functions Brief</a>
<li><a href="manual/pyaqsapiFunctions-Brief.html#index-0">pyaqsapi Functions Brief;</a>
</li>
<li><a href="index.html#index-8">pyaqsapi Functions Long</a>, <a href="manual/pyaqsapiFunctions-Long.html#index-0">[1]</a>
<li><a href="index.html#index-8">pyaqsapi Functions Long;</a>, <a href="manual/pyaqsapiFunctions-Long.html#index-0">[1]</a>
</li>
<li>
pyaqsapi.bybox
Expand Down Expand Up @@ -689,13 +689,13 @@ <h2 id="S">S</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="manual/pyaqsapiFunctions-Brief.html#index-2">services</a>
<li><a href="manual/pyaqsapiFunctions-Brief.html#index-2">services;</a>
</li>
<li><a href="pyaqsapi.html#pyaqsapi.helperfunctions.AQSAPI_V2.set_data">set_data() (pyaqsapi.helperfunctions.AQSAPI_V2 method)</a>
</li>
<li><a href="pyaqsapi.html#pyaqsapi.helperfunctions.AQSAPI_V2.set_header">set_header() (pyaqsapi.helperfunctions.AQSAPI_V2 method)</a>
</li>
<li><a href="index.html#index-6">sign_up</a>, <a href="manual/Using_pyaqsapi.html#index-1">[1]</a>
<li><a href="index.html#index-6">sign_up;</a>, <a href="manual/Using_pyaqsapi.html#index-1">[1]</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -723,19 +723,19 @@ <h2 id="T">T</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-9">Troubleshooting pyaqsapi</a>, <a href="manual/Troubleshooting.html#index-0">[1]</a>
<li><a href="index.html#index-9">Troubleshooting pyaqsapi;</a>, <a href="manual/Troubleshooting.html#index-0">[1]</a>
</li>
</ul></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-7">Useage tips and precuations</a>, <a href="manual/pyaqsapiusagetipsandprecautions.html#index-0">[1]</a>
<li><a href="index.html#index-7">Useage tips and precuations;</a>, <a href="manual/pyaqsapiusagetipsandprecautions.html#index-0">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#index-5">Using pyaqsapi</a>, <a href="manual/Using_pyaqsapi.html#index-0">[1]</a>
<li><a href="index.html#index-5">Using pyaqsapi;</a>, <a href="manual/Using_pyaqsapi.html#index-0">[1]</a>
</li>
</ul></td>
</tr></table>
Expand Down
40 changes: 0 additions & 40 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,6 @@
<h1>pyaqsapi user documentation<a class="headerlink" href="#pyaqsapi-user-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
</div>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
<section id="epa-disclaimer">
<span id="index-0"></span><h2>EPA Disclaimer<a class="headerlink" href="#epa-disclaimer" title="Link to this heading"></a></h2>
<div class="admonition note">
Expand Down Expand Up @@ -145,10 +141,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
software, service, hardware, or user accounts that may utilize this
package.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="introduction">
<span id="index-1"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h2>
Expand All @@ -171,10 +163,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
data requested, header information, and other metadata related to the API call.
After each call to the API a five second stall is invoked to help prevent
overloading the Data Mart API server and to serve as a simple rate limit.</p>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="about-the-timeliness-of-aqs-data">
<span id="index-2"></span><h2>About the timeliness of AQS Data<a class="headerlink" href="#about-the-timeliness-of-aqs-data" title="Link to this heading"></a></h2>
Expand All @@ -183,10 +171,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
use the AirNow API and direct all questions toward real time data there.
pyaqsapi does not work with AirNow and cannot retrieve real time data. For more
details see section 7.1 of the About AQS Data page <span id="id2"></span>.</p>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="install-pyaqsapi">
<span id="index-3"></span><h2>Install pyaqsapi<a class="headerlink" href="#install-pyaqsapi" title="Link to this heading"></a></h2>
Expand All @@ -206,10 +190,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
<span class="go">python -m pip install .</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="load-pyaqsapi">
<span id="index-4"></span><h2>Load pyaqsapi<a class="headerlink" href="#load-pyaqsapi" title="Link to this heading"></a></h2>
Expand All @@ -219,10 +199,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pyaqsapi</span> <span class="k">as</span> <span class="nn">aqs</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="using-pyaqsapi">
<span id="index-5"></span><h2>Using pyaqsapi<a class="headerlink" href="#using-pyaqsapi" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -273,10 +249,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
same credentials used in RAQSAPI in pyaqsapi since RAQSAPI ewes the the same
AQS Data Mart API as pyaqsapi.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="usage-tips-and-precautions">
<span id="index-7"></span><h2>Usage tips and precautions<a class="headerlink" href="#usage-tips-and-precautions" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -352,10 +324,6 @@ <h2>AQS DataMart Disclaimer<a class="headerlink" href="#aqs-datamart-disclaimer"
<p><strong>The AQS Data Mart administrators may disable accounts without notice for
failure to adhere to these terms (Though they will contact the offending
user via the email address provided)</strong></p>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="functions-exported-by-pyaqsapi">
<span id="index-8"></span><h2>Functions Exported by pyaqsapi<a class="headerlink" href="#functions-exported-by-pyaqsapi" title="Link to this heading"></a></h2>
Expand Down Expand Up @@ -1360,10 +1328,6 @@ <h3>pyaqsapi Miscellaneous functions<a class="headerlink" href="#pyaqsapi-miscel
<ul class="simple">
<li><p>AQSobject:</p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
</section>
<section id="troubleshooting">
Expand All @@ -1372,10 +1336,6 @@ <h3>pyaqsapi Miscellaneous functions<a class="headerlink" href="#pyaqsapi-miscel
stateFIPS for Alabama is “01”, entering a value of “1” for the stateFIPS
may lead to unexpected results. Do not omit leading zeros in parameters that
expect them.</p>
<dl class="field-list simple">
<dt class="field-odd">orphan<span class="colon">:</span></dt>
<dd class="field-odd"><p></p></dd>
</dl>
</section>
<section id="about-raqsapi">
<span id="index-10"></span><h2>About RAQSAPI<a class="headerlink" href="#about-raqsapi" title="Link to this heading"></a></h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ pyaqsapi API reference documentation

pyaqsapi index
--------------

* :ref:`genindex`

References
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/EPA_Disclaimer.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: EPA Disclaimer
.. index:: EPA Disclaimer;

EPA Disclaimer
==============
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/Install_pyaqsapi.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Install pyaqsapi
.. index:: Install pyaqsapi;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Install pyaqsapi
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/Introduction.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Introduction
.. index:: Introduction;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Introduction
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/Load_pyaqsapi.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: Load pyaqsapi
.. index:: Load pyaqsapi;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

Load pyaqsapi
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/RAQSAPI.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: About RAQSAPI
.. index:: About RAQSAPI;
.. sectionauthor:: Clinton Mccrowey \<mccrowey \<DOT\>\ clinton \<AT\>\ epa.gov\>

About RAQSAPI
Expand Down
4 changes: 1 addition & 3 deletions docs/manual/TimelinessofAQSdata.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
:orphan:

.. index:: About the timeliness of AQS Data
.. index:: About the timeliness of AQS;

About the timeliness of AQS Data
================================
Expand Down
Loading

0 comments on commit 74aea23

Please sign in to comment.