Update documentation

OceanNetworksCanada · Sep 20, 2024 · 2a6e00c · 2a6e00c
commit 2a6e00c
Show file tree

Hide file tree

Showing 131 changed files with 21,174 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: 76f3a956b8ce1f005c93054d0b8af748
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/API_Guide.doctree b/.doctrees/API_Guide.doctree
diff --git a/.doctrees/Code_Examples/Discover_Data_Products.doctree b/.doctrees/Code_Examples/Discover_Data_Products.doctree
diff --git a/.doctrees/Code_Examples/Discover_Deployments.doctree b/.doctrees/Code_Examples/Discover_Deployments.doctree
diff --git a/.doctrees/Code_Examples/Discover_Device_Categories.doctree b/.doctrees/Code_Examples/Discover_Device_Categories.doctree
diff --git a/.doctrees/Code_Examples/Discover_Devices.doctree b/.doctrees/Code_Examples/Discover_Devices.doctree
diff --git a/.doctrees/Code_Examples/Discover_Locations.doctree b/.doctrees/Code_Examples/Discover_Locations.doctree
diff --git a/.doctrees/Code_Examples/Discover_Properties.doctree b/.doctrees/Code_Examples/Discover_Properties.doctree
diff --git a/.doctrees/Code_Examples/Download_Archived_Files.doctree b/.doctrees/Code_Examples/Download_Archived_Files.doctree
diff --git a/.doctrees/Code_Examples/Download_Data_Products.doctree b/.doctrees/Code_Examples/Download_Data_Products.doctree
diff --git a/.doctrees/Code_Examples/Request_Real_Time_Data.doctree b/.doctrees/Code_Examples/Request_Real_Time_Data.doctree
diff --git a/.doctrees/Code_Examples/index.doctree b/.doctrees/Code_Examples/index.doctree
diff --git a/.doctrees/Tutorial/Oceans_3.0_API_Tutorial.doctree b/.doctrees/Tutorial/Oceans_3.0_API_Tutorial.doctree
diff --git a/.doctrees/Tutorial/index.doctree b/.doctrees/Tutorial/index.doctree
diff --git a/.doctrees/Tutorial/onc_Library_Tutorial.doctree b/.doctrees/Tutorial/onc_Library_Tutorial.doctree
diff --git a/.doctrees/autoapi/index.doctree b/.doctrees/autoapi/index.doctree
diff --git a/.doctrees/autoapi/onc/index.doctree b/.doctrees/autoapi/onc/index.doctree
diff --git a/.doctrees/autoapi/onc/util/index.doctree b/.doctrees/autoapi/onc/util/index.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/contributing.doctree b/.doctrees/contributing.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_Guide.html b/API_Guide.html
@@ -0,0 +1,122 @@
+<!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>API Guide &mdash; onc 2.4.0 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" />
+      <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
+      <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
+      <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
+
+
+    <link rel="shortcut icon" href="https://data.oceannetworks.ca/favicon.ico"/>
+  <!--[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=4d935f96"></script>
+        <script src="_static/doctools.js?v=9a2dae69"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
+        <script src="_static/clipboard.min.js?v=a7894cd8"></script>
+        <script src="_static/copybutton.js?v=f281be69"></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="next" title="Changelog" href="changelog.html" />
+    <link rel="prev" title="Contributing" href="contributing.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">
+            onc
+          </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="Tutorial/index.html">Tutorial</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Code_Examples/index.html">Code Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">API Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
+<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</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">onc</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">API Guide</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/API_Guide.md.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="api-guide">
+<h1>API Guide<a class="headerlink" href="#api-guide" title="Link to this heading"></a></h1>
+<p>Please check <a class="reference external" href="https://oceannetworkscanada.github.io/Oceans3.0-API/API_Guide.html">Oceans 3.0 API guide</a> for more information.</p>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="changelog.html" class="btn btn-neutral float-right" title="Changelog" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, ONC Data Team.</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>