refactor the pyaqsapi documentation

USEPA · Jan 29, 2024 · 36a0528 · 36a0528
1 parent cd8c039
commit 36a0528
Show file tree

Hide file tree

Showing 49 changed files with 3,986 additions and 9,483 deletions.
diff --git a/docs/_/output.txt b/docs/_/output.txt
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/manual/pyaqsapiFunctions-Brief.doctree b/docs/_build/doctrees/manual/pyaqsapiFunctions-Brief.doctree
diff --git a/docs/_build/doctrees/manual/pyaqsapiFunctions-Long.doctree b/docs/_build/doctrees/manual/pyaqsapiFunctions-Long.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.bybox.doctree b/docs/_build/doctrees/pyaqsapi.bybox.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.bycbsa.doctree b/docs/_build/doctrees/pyaqsapi.bycbsa.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.bycounty.doctree b/docs/_build/doctrees/pyaqsapi.bycounty.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.byma.doctree b/docs/_build/doctrees/pyaqsapi.byma.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.bypqao.doctree b/docs/_build/doctrees/pyaqsapi.bypqao.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.bysite.doctree b/docs/_build/doctrees/pyaqsapi.bysite.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.bystate.doctree b/docs/_build/doctrees/pyaqsapi.bystate.doctree
diff --git a/docs/_build/doctrees/pyaqsapi.doctree b/docs/_build/doctrees/pyaqsapi.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +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: 3cebc56d58d6ed3f3392a68420c06fa8
+config: 76a68937cbe1e6a63755071eed15d2c3
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -3,12 +3,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+.. sectionauthor:: Clinton Mccrowey <mccrowey.clinton <AT> epa.gov>
+
+===========================
+pyaqsapi user documentation
+===========================
 
-pyaqsapi's documentation
-=========================
 .. toctree::
   :maxdepth: 2
   :numbered:
+  :hidden:
 
 .. include:: manual/EPA_Disclaimer.rst
 .. include:: manual/Introduction.rst
@@ -19,12 +23,17 @@ pyaqsapi's documentation
 .. include:: manual/Using_pyaqsapi.rst
 ..
     This is temporary until the long version is finished
-.. include:: manual/pyaqsapiFunctions-Brief.rst
+..
+.. include:: manual/pyaqsapiFunctions-Long.rst
+
 
 pyaqsapi API reference documentation
-====================================
+------------------------------------
+
 * :ref:`modindex`
 
-Index
-=====
+
+pyaqsapi index
+--------------
+
 * :ref:`genindex`
diff --git a/docs/_build/html/_sources/manual/pyaqsapiFunctions-Brief.rst.txt b/docs/_build/html/_sources/manual/pyaqsapiFunctions-Brief.rst.txt
@@ -1,4 +1,4 @@
-.. index:: pyaqsapi aggregate functions (brief)
+:orphan:
 
 Data Mart aggregate functions
 =============================
@@ -34,25 +34,24 @@ Note that not all aggregations are available for each service.
 
 These thirteen services are:
 
-    - \ Monitors (\*monitors)
-    - \ Sample Data (\*sampledata)
-    - \ Daily Summary Data (\*dailydata)
-    - \ Annual Summary Data (annualdata)
-    - \ Quality Assurance - Blanks Data (\*qa_blanks)
-    - \ Quality Assurance - Collocated Assessments
-      (\*qa_collocated_assessments)
-    - \ Quality Assurance - Flow Rate Verifications (\*qa_flowrateverification)
-    - \ Quality Assurance - Flow Rate Audits (\*aqs_qa_flowrateaudit)
-    - \ Quality Assurance - One Point Quality Control Raw Data
-      (\*qa_one_point_qc)
-    - \ Quality Assurance - PEP Audits (\*qa_pep_audit)
-    - \ Transaction Sample - AQS Submission data in transaction Format (RD)
-      (\*transactionsample)
-    - \ Quality Assurance - Annual Performance Evaluations
-      (\*qa_annualpeferomanceeval)
-    - \ Quality Assurance - Annual Performance Evaluations in the AQS
-      \ Submission transaction format (RD)
-      \ (\*qa_annualpeferomanceevaltransaction)
+    * Monitors (monitors)
+    * Sample Data (sampledata)
+    * Daily Summary Data (dailydata)
+    * Annual Summary Data (annualdata)
+    * Quality Assurance - Blanks Data (qa_blanks)
+    * Quality Assurance - Collocated Assessments
+      (qa_collocated_assessments)
+    * Quality Assurance - Flow Rate Verifications (qa_flowrateverification)
+    * Quality Assurance - Flow Rate Audits (aqs_qa_flowrateaudit)
+    * Quality Assurance - One Point Quality Control Raw Data
+      (qa_one_point_qc)
+    * Quality Assurance - PEP Audits (qa_pep_audit)
+    * Transaction Sample - AQS Submission data in transaction Format (RD)
+      (transactionsample)
+    * Quality Assurance - Annual Performance Evaluations
+      (qa_annualperformanceeval)
+    * Quality Assurance - Annual Performance Evaluations in the AQS
+      Submission transaction format (RD) (qa_annualperformanceevaltransaction)
 
 
 Aggregate functions are named aqs.<aggregation>.<service>() where <service>