Update documentation

internetofwater · Oct 2, 2024 · 33a2aa4 · 33a2aa4
commit 33a2aa4
Show file tree

Hide file tree

Showing 65 changed files with 7,513 additions and 0 deletions.
diff --git a/.buildinfo b/.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: 703c52263c04e32027827079828f22b2
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/API.doctree b/.doctrees/API.doctree
diff --git a/.doctrees/About.doctree b/.doctrees/About.doctree
diff --git a/.doctrees/Endpoints.doctree b/.doctrees/Endpoints.doctree
diff --git a/.doctrees/Glossary.doctree b/.doctrees/Glossary.doctree
diff --git a/.doctrees/Overview.doctree b/.doctrees/Overview.doctree
diff --git a/.doctrees/Plugins.doctree b/.doctrees/Plugins.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/API.html b/API.html
diff --git a/About.html b/About.html
@@ -0,0 +1,230 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <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>About This Project &mdash; NLDI API Service (python)  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?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></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" />
+    <link rel="prev" title="Glossary" href="Glossary.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">
+            NLDI API Service (python)
+          </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" aria-label="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="Navigation menu">
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="Overview.html">Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="API.html">NLDI API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Plugins.html">Plugins</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Glossary.html">Glossary</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">About This Project</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#nldi-contribution-guidelines">NLDI Contribution Guidelines</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#linked-data-contribution">Linked Data Contribution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#code-contribution">Code Contribution</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#ideas-and-bug-reports">Ideas and Bug Reports</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="#license">LICENSE</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#cc0-1-0-universal-summary">CC0 1.0 Universal Summary</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#no-copyright">No Copyright</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#other-information">Other Information</a></li>
+</ul>
+</li>
+<li class="toctree-l3"><a class="reference internal" href="#prior-work">Prior Work</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#nldi-py">nldi-py</a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">NLDI API Service (python)</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">About This Project</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/About.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">
+
+  <section id="about-this-project">
+<h1>About This Project<a class="headerlink" href="#about-this-project" title="Link to this heading"></a></h1>
+<hr class="docutils" />
+<section id="nldi-contribution-guidelines">
+<h2>NLDI Contribution Guidelines<a class="headerlink" href="#nldi-contribution-guidelines" title="Link to this heading"></a></h2>
+<p>First, Thank you for considering a contribution. This project is
+a community resource, its success is contingent on your contributions.</p>
+<section id="linked-data-contribution">
+<h3>Linked Data Contribution<a class="headerlink" href="#linked-data-contribution" title="Link to this heading"></a></h3>
+<p>Linked data contributions are made through a configuration of the
+<a class="reference external" href="https://github.com/internetofwater/nldi-crawler#contributing">NLDI Crawler</a> in the
+<a class="reference external" href="https://github.com/internetofwater/nldi-db/blob/master/liquibase/changeLogs/nldi/nldi_data/update_crawler_source/crawler_source.tsv">NLDI Database</a>.</p>
+<p>For support in this process, open
+<a class="reference external" href="https://github.com/internetofwater/nldi-services/issues">an issue in the NLDI-Services</a> repository.</p>
+</section>
+<section id="code-contribution">
+<h3>Code Contribution<a class="headerlink" href="#code-contribution" title="Link to this heading"></a></h3>
+<p>Contribution to the overall project are more than welcome. Please open
+an issue describing the goal of your contribution in the
+<a class="reference external" href="https://github.com/internetofwater/nldi-services/issues">NLDI-Services</a>
+repository prior to opening a pull request.</p>
+<p>Contributions may ultimately reside in the services, database, or crawler
+repositories. All pull requests should link back to the issues in the
+services repository to ensure we track contributions in a single location.</p>
+</section>
+<section id="ideas-and-bug-reports">
+<h3>Ideas and Bug Reports<a class="headerlink" href="#ideas-and-bug-reports" title="Link to this heading"></a></h3>
+<p>For ideas for new features and bug reports, please register them as
+issues in the <a class="reference external" href="https://github.com/internetofwater/nldi-services/issues">NLDI-Services</a>
+repository.</p>
+</section>
+</section>
+<hr class="docutils" />
+<section id="license">
+<h2>LICENSE<a class="headerlink" href="#license" title="Link to this heading"></a></h2>
+<p>Unless otherwise noted, This project is in the public domain in the United
+States. It is licenced under CC0 1.0 Universal (see <a class="reference external" href="http://creativecommons.org/publicdomain/zero/1.0/">http://creativecommons.org/publicdomain/zero/1.0/</a>).</p>
+<section id="cc0-1-0-universal-summary">
+<h3>CC0 1.0 Universal Summary<a class="headerlink" href="#cc0-1-0-universal-summary" title="Link to this heading"></a></h3>
+<p>This is a human-readable summary of the Legal Code (<a class="reference external" href="https://creativecommons.org/publicdomain/zero/1.0/legalcode">read the full text</a>).</p>
+<section id="no-copyright">
+<h4>No Copyright<a class="headerlink" href="#no-copyright" title="Link to this heading"></a></h4>
+<p>The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.</p>
+<p>You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.</p>
+</section>
+<section id="other-information">
+<h4>Other Information<a class="headerlink" href="#other-information" title="Link to this heading"></a></h4>
+<p>In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.</p>
+<p>Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.</p>
+</section>
+</section>
+<section id="prior-work">
+<h3>Prior Work<a class="headerlink" href="#prior-work" title="Link to this heading"></a></h3>
+<section id="nldi-py">
+<h4>nldi-py<a class="headerlink" href="#nldi-py" title="Link to this heading"></a></h4>
+<p>This software is derived from the original <code class="docutils literal notranslate"><span class="pre">nldi-py</span></code> project, which bears
+the following copyright notice:</p>
+<div class="highlight-text notranslate"><div class="highlight"><pre><span></span># =================================================================
+#
+# Author: Benjamin Webb &lt;[email protected]&gt;
+#
+# Copyright (c) 2023 Benjamin Webb
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the &quot;Software&quot;), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# =================================================================
+</pre></div>
+</div>
+</section>
+</section>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="Glossary.html" class="btn btn-neutral float-left" title="Glossary" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Internet of Water.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/Endpoints.html b/Endpoints.html
@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="./">
+<head>
+  <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>&lt;no title&gt; &mdash; NLDI API Service (python)  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?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></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" /> 
+</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">
+            NLDI API Service (python)
+          </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" aria-label="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="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="About.html">About This Project</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="index.html">NLDI API Service (python)</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">&lt;no title&gt;</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/Endpoints.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">
+
+  <p>Image from <a class="reference external" href="https://labs.waterdata.usgs.gov/docs/nldi/about-nldi/index.html">https://labs.waterdata.usgs.gov/docs/nldi/about-nldi/index.html</a></p>
+
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Internet of Water.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>