sphinx testing: added module names to index

ascheliga · Jan 5, 2024 · 944eefd · 944eefd
1 parent 7221973
commit 944eefd
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 3 deletions.
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/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -10,7 +10,8 @@ Welcome to CYGNSS-GRACE codebase's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-
+   area_calcs
+   area_subsets
 
 Indices and tables
 ==================

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -167,6 +167,11 @@ <h1 class="logo"><a href="index.html">CYGNSS-GRACE codebase</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="area_calcs.html">area_calcs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="area_subsets.html">area_subsets</a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -13,6 +13,7 @@
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="area_calcs" href="area_calcs.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -32,6 +33,30 @@
   <section id="welcome-to-cygnss-grace-codebase-s-documentation">
 <h1>Welcome to CYGNSS-GRACE codebase’s documentation!<a class="headerlink" href="#welcome-to-cygnss-grace-codebase-s-documentation" title="Link to this heading">¶</a></h1>
 <div class="toctree-wrapper compound">
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="area_calcs.html">area_calcs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="area_calcs.html#codebase.area_calcs.CYGNSS_001_areal_average"><code class="docutils literal notranslate"><span class="pre">CYGNSS_001_areal_average()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_calcs.html#codebase.area_calcs.GRACE_areal_average"><code class="docutils literal notranslate"><span class="pre">GRACE_areal_average()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_calcs.html#codebase.area_calcs.area_frac_calc"><code class="docutils literal notranslate"><span class="pre">area_frac_calc()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_calcs.html#codebase.area_calcs.cygnss_convert_to_binary"><code class="docutils literal notranslate"><span class="pre">cygnss_convert_to_binary()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_calcs.html#codebase.area_calcs.pos_neg_area_calc"><code class="docutils literal notranslate"><span class="pre">pos_neg_area_calc()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_calcs.html#codebase.area_calcs.stat_check"><code class="docutils literal notranslate"><span class="pre">stat_check()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="area_subsets.html">area_subsets</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.check_for_multiple_dams"><code class="docutils literal notranslate"><span class="pre">check_for_multiple_dams()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.cygnss_point_subset"><code class="docutils literal notranslate"><span class="pre">cygnss_point_subset()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.cygnss_shape_subset"><code class="docutils literal notranslate"><span class="pre">cygnss_shape_subset()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.grace_point_subset"><code class="docutils literal notranslate"><span class="pre">grace_point_subset()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.grace_shape_subset"><code class="docutils literal notranslate"><span class="pre">grace_shape_subset()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.precip_point_subset"><code class="docutils literal notranslate"><span class="pre">precip_point_subset()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.precip_shape_subset"><code class="docutils literal notranslate"><span class="pre">precip_shape_subset()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.reservoir_name_to_point"><code class="docutils literal notranslate"><span class="pre">reservoir_name_to_point()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="area_subsets.html#codebase.area_subsets.xr_shape_subset"><code class="docutils literal notranslate"><span class="pre">xr_shape_subset()</span></code></a></li>
+</ul>
+</li>
+</ul>
 </div>
 </section>
 <section id="indices-and-tables">
@@ -60,11 +85,17 @@ <h1 class="logo"><a href="#">CYGNSS-GRACE codebase</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="area_calcs.html">area_calcs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="area_subsets.html">area_subsets</a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
   <li><a href="#">Documentation overview</a><ul>
+      <li>Next: <a href="area_calcs.html" title="next chapter">area_calcs</a></li>
   </ul></li>
 </ul>
 </div>

diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
@@ -77,6 +77,11 @@ <h1 class="logo"><a href="index.html">CYGNSS-GRACE codebase</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="area_calcs.html">area_calcs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="area_subsets.html">area_subsets</a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>

diff --git a/docs/build/html/search.html b/docs/build/html/search.html
@@ -81,6 +81,11 @@ <h1 class="logo"><a href="index.html">CYGNSS-GRACE codebase</a></h1>
 
 
 <h3>Navigation</h3>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="area_calcs.html">area_calcs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="area_subsets.html">area_subsets</a></li>
+</ul>
 
 <div class="relations">
 <h3>Related Topics</h3>