generated doc

qscat · Jul 18, 2024 · f3a2f7c · f3a2f7c
1 parent e2c6c2b
commit f3a2f7c
Show file tree

Hide file tree

Showing 39 changed files with 174 additions and 99 deletions.
diff --git a/docs/master/_sources/changelog/0.4.1-changelog.rst.txt b/docs/master/_sources/changelog/0.4.1-changelog.rst.txt
@@ -0,0 +1,26 @@
+==================================
+QSCAT 0.4.1 Changelog - 2024-07-18
+==================================
+
+Fixed
+=====
+
+- `Forecasting Tab`: Fix issue on forecasting generating weird uncertainty points when date value of month is not 01.
+- Fix proper end time logging of shoreline change and forecasting.
+- Minor bug fixes.
+
+Added
+=====
+
+- `Visualization Tab`: Add option to select column, and input uncertainty value to support layers generated outside QSCAT.
+- `Baseline Tab`, `Automator Tab`: Add smoothing distance field.
+- `Shoreline Change Tab`, `Area Change Tab`, `Forecasting Tab`, `Visualization Tab`, `Summary Reports Tab`: Add input saving.
+- `Help Tab`: Add useful links.
+- `Shorelines Tab`: Add selected shorelines layer validation when changing layer selections.
+
+Changed
+=======
+
+- `Shoreline Change Tab`: Make newest and oldest date selection automatic; no need to button to update.
+- Major code reformatting and refactor.
+- `User Manual`: Update figures and texts.
diff --git a/docs/master/_sources/manual/tabs/summary_reports.rst.txt b/docs/master/_sources/manual/tabs/summary_reports.rst.txt
@@ -248,20 +248,4 @@ Summary of results
 Forecasting
 -----------
 
-Input parameters
-................
-
-Summary of results
-..................
-
-**Forecast points**
-
-*Content for this section will be added soon.*
-
-**Forecast line**
-
-*Content for this section will be added soon.*
-
-**Forecast area**
-
-*Content for this section will be added soon.*
+*The Forecasting summary report is not yet available.*
diff --git a/docs/master/_static/documentation_options.js b/docs/master/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.4.0',
+    VERSION: '0.4.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/master/changelog/0.1.0-changelog.html b/docs/master/changelog/0.1.0-changelog.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -385,6 +385,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="0.4.1-changelog.html">0.4.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.4.0-changelog.html">0.4.0</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.1-changelog.html">0.3.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.0-changelog.html">0.3.0</a></li>

diff --git a/docs/master/changelog/0.2.0-changelog.html b/docs/master/changelog/0.2.0-changelog.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -386,6 +386,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="0.4.1-changelog.html">0.4.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.4.0-changelog.html">0.4.0</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.1-changelog.html">0.3.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.0-changelog.html">0.3.0</a></li>

diff --git a/docs/master/changelog/0.3.0-changelog.html b/docs/master/changelog/0.3.0-changelog.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -386,6 +386,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="0.4.1-changelog.html">0.4.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.4.0-changelog.html">0.4.0</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.1-changelog.html">0.3.1</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">0.3.0</a></li>

diff --git a/docs/master/changelog/0.3.1-changelog.html b/docs/master/changelog/0.3.1-changelog.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -386,6 +386,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="0.4.1-changelog.html">0.4.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.4.0-changelog.html">0.4.0</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">0.3.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.0-changelog.html">0.3.0</a></li>

diff --git a/docs/master/changelog/0.4.0-changelog.html b/docs/master/changelog/0.4.0-changelog.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -48,7 +48,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="QSCAT 0.3.1 Changelog - 2024-04-21" href="0.3.1-changelog.html" />
-    <link rel="prev" title="Changelog" href="index.html" />
+    <link rel="prev" title="QSCAT 0.4.1 Changelog - 2024-07-18" href="0.4.1-changelog.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
     <meta name="docbuild:last-update" content="May 06, 2024"/>
@@ -386,6 +386,7 @@
      aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="0.4.1-changelog.html">0.4.1</a></li>
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">0.4.0</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.1-changelog.html">0.3.1</a></li>
 <li class="toctree-l1"><a class="reference internal" href="0.3.0-changelog.html">0.3.0</a></li>
@@ -504,12 +505,12 @@ <h2>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permal
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="index.html"
+       href="0.4.1-changelog.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">Changelog</p>
+        <p class="prev-next-title">QSCAT 0.4.1 Changelog - 2024-07-18</p>
       </div>
     </a>
     <a class="right-next"

diff --git a/docs/master/changelog/0.4.1-changelog.html b/docs/master/changelog/0.4.1-changelog.html
@@ -8,6 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
+    <meta property="article:modified_time" content="2024-07-18T15:46:38+08:00" />
     <title>QSCAT 0.4.1 Changelog - 2024-07-18 &#8212; QSCAT</title>
 
 
@@ -37,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -46,8 +47,11 @@
     <link rel="icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="QSCAT 0.4.0 Changelog - 2024-05-06" href="0.4.0-changelog.html" />
+    <link rel="prev" title="Changelog" href="index.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
+    <meta name="docbuild:last-update" content="Jul 18, 2024"/>
   </head>
 
 
@@ -150,7 +154,7 @@
                     </li>
 
 
-                    <li class="nav-item">
+                    <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="index.html">
                         Changelog
                       </a>
@@ -288,7 +292,7 @@
                     </li>
 
 
-                    <li class="nav-item">
+                    <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="index.html">
                         Changelog
                       </a>
@@ -377,6 +381,20 @@
          spellcheck="false"/>
   <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 </form></div>
+        <div class="sidebar-primary-item">
+<nav class="bd-docs-nav bd-links"
+     aria-label="Section Navigation">
+  <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
+  <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">0.4.1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="0.4.0-changelog.html">0.4.0</a></li>
+<li class="toctree-l1"><a class="reference internal" href="0.3.1-changelog.html">0.3.1</a></li>
+<li class="toctree-l1"><a class="reference internal" href="0.3.0-changelog.html">0.3.0</a></li>
+<li class="toctree-l1"><a class="reference internal" href="0.2.0-changelog.html">0.2.0</a></li>
+<li class="toctree-l1"><a class="reference internal" href="0.1.0-changelog.html">0.1.0</a></li>
+</ul>
+</div>
+</nav></div>
     </div>
 
 
@@ -411,6 +429,9 @@
         <i class="fa-solid fa-home"></i>
       </a>
     </li>
+
+    <li class="breadcrumb-item"><a href="index.html" class="nav-link">Changelog</a></li>
+
     <li class="breadcrumb-item active" aria-current="page">QSCAT 0.4.1...</li>
   </ul>
 </nav>
@@ -463,11 +484,40 @@ <h2>Changed<a class="headerlink" href="#changed" title="Permalink to this headin
 
 
 
+                <footer class="bd-footer-article">
+                  <div class="footer-article-items footer-article__inner">
+
+    <div class="footer-article-item"><p class="last-updated">
+  Last updated on Jul 18, 2024.
+  <br/>
+</p></div>
+
+</div>
+                </footer>
+
 
 
                 <footer class="prev-next-footer">
 
 <div class="prev-next-area">
+    <a class="left-prev"
+       href="index.html"
+       title="previous page">
+      <i class="fa-solid fa-angle-left"></i>
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">previous</p>
+        <p class="prev-next-title">Changelog</p>
+      </div>
+    </a>
+    <a class="right-next"
+       href="0.4.0-changelog.html"
+       title="next page">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">next</p>
+        <p class="prev-next-title">QSCAT 0.4.0 Changelog - 2024-05-06</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
 </div>
                 </footer>
 
@@ -490,6 +540,31 @@ <h2>Changed<a class="headerlink" href="#changed" title="Permalink to this headin
 </ul>
   </nav></div>
 
+  <div class="sidebar-secondary-item">
+
+
+  <div class="tocsection editthispage">
+    <a href="https://github.com/qscat/qscat/edit/master/docs/source/changelog/0.4.1-changelog.rst">
+      <i class="fa-solid fa-pencil"></i>
+
+
+
+          Edit on GitHub
+
+
+    </a>
+  </div>
+</div>
+
+  <div class="sidebar-secondary-item">
+
+  <div class="tocsection sourcelink">
+    <a href="../_sources/changelog/0.4.1-changelog.rst.txt">
+      <i class="fa-solid fa-file-lines"></i> Show Source
+    </a>
+  </div>
+</div>
+
 </div></div>
 
 

diff --git a/docs/master/changelog/index.html b/docs/master/changelog/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <meta property="article:modified_time" content="2024-05-04T17:21:48+08:00" />
+    <meta property="article:modified_time" content="2024-07-18T15:46:38+08:00" />
     <title>Changelog &#8212; QSCAT</title>
 
 
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>
@@ -51,7 +51,7 @@
     <link rel="prev" title="References" href="../manual/others/references.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-    <meta name="docbuild:last-update" content="May 04, 2024"/>
+    <meta name="docbuild:last-update" content="Jul 18, 2024"/>
   </head>
 
 
@@ -471,7 +471,7 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
                   <div class="footer-article-items footer-article__inner">
 
     <div class="footer-article-item"><p class="last-updated">
-  Last updated on May 04, 2024.
+  Last updated on Jul 18, 2024.
   <br/>
 </p></div>
 

diff --git a/docs/master/genindex.html b/docs/master/genindex.html
@@ -36,7 +36,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=ea00750a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/design-tabs.js?v=36754332"></script>

diff --git a/docs/master/index.html b/docs/master/index.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=ea00750a"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="_static/design-tabs.js?v=36754332"></script>

diff --git a/docs/master/manual/index.html b/docs/master/manual/index.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../_static/design-tabs.js?v=36754332"></script>

diff --git a/docs/master/manual/introduction/features.html b/docs/master/manual/introduction/features.html
@@ -38,7 +38,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=5b4479735964841361fd" />
   <script src="../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=5b4479735964841361fd"></script>
 
-    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=4e78f113"></script>
+    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=ea00750a"></script>
     <script src="../../_static/doctools.js?v=888ff710"></script>
     <script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
     <script src="../../_static/design-tabs.js?v=36754332"></script>