Clean up docs build for automation (MHKiT-Software#81)

* Automate doc deployment * And conda environment * remove old build files
ssolson · Feb 3, 2025 · ce29db3 · ce29db3
commit ce29db3
Show file tree

Hide file tree

Showing 290 changed files with 69,622 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f3eeb7c7991751ab357dc82f73f95d56
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/acoustics.doctree b/.doctrees/acoustics.doctree
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/citeus.doctree b/.doctrees/citeus.doctree
diff --git a/.doctrees/contact.doctree b/.doctrees/contact.doctree
diff --git a/.doctrees/dolfyn.doctree b/.doctrees/dolfyn.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/examples.doctree b/.doctrees/examples.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/.doctrees/license.doctree b/.doctrees/license.doctree
diff --git a/.doctrees/loads.doctree b/.doctrees/loads.doctree
diff --git a/.doctrees/matlab_installation.doctree b/.doctrees/matlab_installation.doctree
diff --git a/.doctrees/mhkit-matlab/api.dolfyn.doctree b/.doctrees/mhkit-matlab/api.dolfyn.doctree
diff --git a/.doctrees/mhkit-matlab/api.loads.doctree b/.doctrees/mhkit-matlab/api.loads.doctree
diff --git a/.doctrees/mhkit-matlab/api.power.doctree b/.doctrees/mhkit-matlab/api.power.doctree
diff --git a/.doctrees/mhkit-matlab/api.qc.doctree b/.doctrees/mhkit-matlab/api.qc.doctree
diff --git a/.doctrees/mhkit-matlab/api.river.doctree b/.doctrees/mhkit-matlab/api.river.doctree
diff --git a/.doctrees/mhkit-matlab/api.tidal.doctree b/.doctrees/mhkit-matlab/api.tidal.doctree
diff --git a/.doctrees/mhkit-matlab/api.utils.doctree b/.doctrees/mhkit-matlab/api.utils.doctree
diff --git a/.doctrees/mhkit-matlab/api.wave.doctree b/.doctrees/mhkit-matlab/api.wave.doctree
diff --git a/.doctrees/mhkit-python/api.acoustics.doctree b/.doctrees/mhkit-python/api.acoustics.doctree
diff --git a/.doctrees/mhkit-python/api.dolfyn.doctree b/.doctrees/mhkit-python/api.dolfyn.doctree
diff --git a/.doctrees/mhkit-python/api.loads.doctree b/.doctrees/mhkit-python/api.loads.doctree
diff --git a/.doctrees/mhkit-python/api.mooring.doctree b/.doctrees/mhkit-python/api.mooring.doctree
diff --git a/.doctrees/mhkit-python/api.power.doctree b/.doctrees/mhkit-python/api.power.doctree
diff --git a/.doctrees/mhkit-python/api.qc.doctree b/.doctrees/mhkit-python/api.qc.doctree
diff --git a/.doctrees/mhkit-python/api.river.doctree b/.doctrees/mhkit-python/api.river.doctree
diff --git a/.doctrees/mhkit-python/api.tidal.doctree b/.doctrees/mhkit-python/api.tidal.doctree
diff --git a/.doctrees/mhkit-python/api.utils.doctree b/.doctrees/mhkit-python/api.utils.doctree
diff --git a/.doctrees/mhkit-python/api.wave.doctree b/.doctrees/mhkit-python/api.wave.doctree
diff --git a/.doctrees/module.doctree b/.doctrees/module.doctree
diff --git a/.doctrees/mooring.doctree b/.doctrees/mooring.doctree
diff --git a/.doctrees/overview.doctree b/.doctrees/overview.doctree
diff --git a/.doctrees/power.doctree b/.doctrees/power.doctree
diff --git a/.doctrees/qc.doctree b/.doctrees/qc.doctree
diff --git a/.doctrees/release_notes.doctree b/.doctrees/release_notes.doctree
diff --git a/.doctrees/river.doctree b/.doctrees/river.doctree
diff --git a/.doctrees/terminology.doctree b/.doctrees/terminology.doctree
diff --git a/.doctrees/tidal.doctree b/.doctrees/tidal.doctree
diff --git a/.doctrees/troubleshooting.doctree b/.doctrees/troubleshooting.doctree
diff --git a/.doctrees/utils.doctree b/.doctrees/utils.doctree
diff --git a/.doctrees/wave.doctree b/.doctrees/wave.doctree
diff --git a/.doctrees/webinars.doctree b/.doctrees/webinars.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/MHKiT_logo.png b/_images/MHKiT_logo.png
diff --git a/_images/install-anaconda_terminal_mhkit_verify_output.png b/_images/install-anaconda_terminal_mhkit_verify_output.png
diff --git a/_images/install_anaconda_conda_dependencies.png b/_images/install_anaconda_conda_dependencies.png
diff --git a/_images/install_anaconda_create_environment.png b/_images/install_anaconda_create_environment.png
diff --git a/_images/install_anaconda_open_environment_terminal.png b/_images/install_anaconda_open_environment_terminal.png
diff --git a/_images/install_anaconda_select_environment_section.png b/_images/install_anaconda_select_environment_section.png
diff --git a/_images/install_anaconda_setup_environment.png b/_images/install_anaconda_setup_environment.png
diff --git a/_images/install_anaconda_terminal_pip_install_downgrade.png b/_images/install_anaconda_terminal_pip_install_downgrade.png
diff --git a/_images/install_anaconda_terminal_pip_install_mhkit.png b/_images/install_anaconda_terminal_pip_install_mhkit.png
diff --git a/_images/install_anaconda_terminal_version_output.png b/_images/install_anaconda_terminal_version_output.png
diff --git a/_images/install_anaconda_terminal_with_environment_name.png b/_images/install_anaconda_terminal_with_environment_name.png
diff --git a/_images/install_github_download_mhkit_matlab_zip.png b/_images/install_github_download_mhkit_matlab_zip.png
diff --git a/_images/install_matlab_addons_list.png b/_images/install_matlab_addons_list.png
diff --git a/_images/install_matlab_python_executable.png b/_images/install_matlab_python_executable.png
diff --git a/_images/install_matlab_toolbox.png b/_images/install_matlab_toolbox.png
diff --git a/_images/install_matlab_verify_mhkit.png b/_images/install_matlab_verify_mhkit.png
diff --git a/_images/install_terminal_mhkit_python_utils_version.png b/_images/install_terminal_mhkit_python_utils_version.png
diff --git a/_images/install_terminal_pip_mhkit_python_utils.png b/_images/install_terminal_pip_mhkit_python_utils.png
diff --git a/_images/mathworks-logo-full-color-rgb.png b/_images/mathworks-logo-full-color-rgb.png
diff --git a/_images/python-logo-master-v3-TM.png b/_images/python-logo-master-v3-TM.png
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,175 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+    <!-- Google tag (gtag.js) -->
+    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-164358105-1"></script>
+    <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag(){dataLayer.push(arguments);}
+        gtag('js', new Date());
+        gtag('config', 'UA-164358105-1');
+    </script>
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; MHKiT v0.9.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5b801204" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=5ea31d45" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/mhkit.css?v=20290a2c" />
+
+
+      <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=c20ff342"></script>
+      <script src="../_static/doctools.js?v=9bcbadda"></script>
+      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+      <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></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">
+            MHKiT
+          </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="../overview.html">Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation.html">MHKiT-Python Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../matlab_installation.html">MHKiT-MATLAB Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../module.html">Module Overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">API Documentation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../troubleshooting.html">Troubleshooting</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../terminology.html">Terminology</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../webinars.html">Webinars</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../release_notes.html">Release Notes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../citeus.html">Cite Us</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../contact.html">Online Forum</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">MHKiT</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">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="mhkit/acoustics/graphics.html">mhkit.acoustics.graphics</a></li>
+<li><a href="mhkit/acoustics/io.html">mhkit.acoustics.io</a></li>
+<li><a href="mhkit/dolfyn/adp/clean.html">mhkit.dolfyn.adp.clean</a></li>
+<li><a href="mhkit/dolfyn/adp/turbulence.html">mhkit.dolfyn.adp.turbulence</a></li>
+<li><a href="mhkit/dolfyn/adv/clean.html">mhkit.dolfyn.adv.clean</a></li>
+<li><a href="mhkit/dolfyn/adv/motion.html">mhkit.dolfyn.adv.motion</a></li>
+<li><a href="mhkit/dolfyn/adv/turbulence.html">mhkit.dolfyn.adv.turbulence</a></li>
+<li><a href="mhkit/dolfyn/binned.html">mhkit.dolfyn.binned</a></li>
+<li><a href="mhkit/dolfyn/io/api.html">mhkit.dolfyn.io.api</a></li>
+<li><a href="mhkit/dolfyn/io/nortek.html">mhkit.dolfyn.io.nortek</a></li>
+<li><a href="mhkit/dolfyn/io/nortek2.html">mhkit.dolfyn.io.nortek2</a></li>
+<li><a href="mhkit/dolfyn/io/rdi.html">mhkit.dolfyn.io.rdi</a></li>
+<li><a href="mhkit/dolfyn/rotate/api.html">mhkit.dolfyn.rotate.api</a></li>
+<li><a href="mhkit/dolfyn/rotate/base.html">mhkit.dolfyn.rotate.base</a></li>
+<li><a href="mhkit/dolfyn/time.html">mhkit.dolfyn.time</a></li>
+<li><a href="mhkit/dolfyn/tools/fft.html">mhkit.dolfyn.tools.fft</a></li>
+<li><a href="mhkit/dolfyn/tools/misc.html">mhkit.dolfyn.tools.misc</a></li>
+<li><a href="mhkit/dolfyn/velocity.html">mhkit.dolfyn.velocity</a></li>
+<li><a href="mhkit/loads/extreme/extremes.html">mhkit.loads.extreme.extremes</a></li>
+<li><a href="mhkit/loads/extreme/mler.html">mhkit.loads.extreme.mler</a></li>
+<li><a href="mhkit/loads/extreme/peaks.html">mhkit.loads.extreme.peaks</a></li>
+<li><a href="mhkit/loads/extreme/sample.html">mhkit.loads.extreme.sample</a></li>
+<li><a href="mhkit/loads/general.html">mhkit.loads.general</a></li>
+<li><a href="mhkit/loads/graphics.html">mhkit.loads.graphics</a></li>
+<li><a href="mhkit/mooring/graphics.html">mhkit.mooring.graphics</a></li>
+<li><a href="mhkit/mooring/io.html">mhkit.mooring.io</a></li>
+<li><a href="mhkit/power/characteristics.html">mhkit.power.characteristics</a></li>
+<li><a href="mhkit/power/quality.html">mhkit.power.quality</a></li>
+<li><a href="mhkit/river/graphics.html">mhkit.river.graphics</a></li>
+<li><a href="mhkit/river/io/d3d.html">mhkit.river.io.d3d</a></li>
+<li><a href="mhkit/river/io/usgs.html">mhkit.river.io.usgs</a></li>
+<li><a href="mhkit/river/performance.html">mhkit.river.performance</a></li>
+<li><a href="mhkit/river/resource.html">mhkit.river.resource</a></li>
+<li><a href="mhkit/tidal/graphics.html">mhkit.tidal.graphics</a></li>
+<li><a href="mhkit/tidal/performance.html">mhkit.tidal.performance</a></li>
+<li><a href="mhkit/tidal/resource.html">mhkit.tidal.resource</a></li>
+<li><a href="mhkit/utils/cache.html">mhkit.utils.cache</a></li>
+<li><a href="mhkit/utils/stat_utils.html">mhkit.utils.stat_utils</a></li>
+<li><a href="mhkit/utils/time_utils.html">mhkit.utils.time_utils</a></li>
+<li><a href="mhkit/utils/type_handling.html">mhkit.utils.type_handling</a></li>
+<li><a href="mhkit/utils/upcrossing.html">mhkit.utils.upcrossing</a></li>
+<li><a href="mhkit/wave/contours.html">mhkit.wave.contours</a></li>
+<li><a href="mhkit/wave/graphics.html">mhkit.wave.graphics</a></li>
+<li><a href="mhkit/wave/io/cdip.html">mhkit.wave.io.cdip</a></li>
+<li><a href="mhkit/wave/io/hindcast/hindcast.html">mhkit.wave.io.hindcast.hindcast</a></li>
+<li><a href="mhkit/wave/io/hindcast/wind_toolkit.html">mhkit.wave.io.hindcast.wind_toolkit</a></li>
+<li><a href="mhkit/wave/io/ndbc.html">mhkit.wave.io.ndbc</a></li>
+<li><a href="mhkit/wave/io/swan.html">mhkit.wave.io.swan</a></li>
+<li><a href="mhkit/wave/io/wecsim.html">mhkit.wave.io.wecsim</a></li>
+<li><a href="mhkit/wave/performance.html">mhkit.wave.performance</a></li>
+<li><a href="mhkit/wave/resource.html">mhkit.wave.resource</a></li>
+<li><a href="pecos/monitoring.html">pecos.monitoring</a></li>
+<li><a href="pecos/utils.html">pecos.utils</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2019, National Renewable Energy Laboratory, Pacific Northwest National Laboratory, and Sandia National Laboratories.</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>