moved notebooks to top of usage_guide

uclamii · Jul 11, 2024 · 7c1b85c · 7c1b85c
1 parent a6f39a3
commit 7c1b85c
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 28 deletions.
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/usage_guide.doctree b/docs/.doctrees/usage_guide.doctree
diff --git a/docs/_sources/usage_guide.rst.txt b/docs/_sources/usage_guide.rst.txt
@@ -30,6 +30,16 @@ Usage Guide
    This documentation is for ``model_tuner`` version ``0.0.11a``.
 
 
+iPython Notebooks
+--------------------
+
+- `Binary Classification Example <https://colab.research.google.com/drive/1D9nl8rLdwxPEpiZplsU0I0lFSAec7NzP?authuser=1#scrollTo=tumIjsNpSAKC&uniqifier=1>`_  
+
+- `Column Transformer Example <https://colab.research.google.com/drive/1ujLL2mRtIWwGamnpWKIo2f271_Q103t-?usp=sharing#scrollTo=uMxyy0yvd2xQ>`_
+
+- `Regression Example <https://colab.research.google.com/drive/151kdlsW-WyJ0pwwt_iWpjXDuqj1Ktam_?authuser=1#scrollTo=UhfZKVoq3sAN>`_
+
+
 Key Methods and Functionalities
 ========================================
 
@@ -511,14 +521,6 @@ Regression Output
    'AveOccup', 'Latitude', 'Longitude']}
 
 
-iPython Notebooks
---------------------
-
-- `Binary Classification Example <https://colab.research.google.com/drive/1D9nl8rLdwxPEpiZplsU0I0lFSAec7NzP?authuser=1#scrollTo=tumIjsNpSAKC&uniqifier=1>`_  
-
-- `Column Transformer Example <https://colab.research.google.com/drive/1ujLL2mRtIWwGamnpWKIo2f271_Q103t-?usp=sharing#scrollTo=uMxyy0yvd2xQ>`_
-
-- `Regression Example <https://colab.research.google.com/drive/151kdlsW-WyJ0pwwt_iWpjXDuqj1Ktam_?authuser=1#scrollTo=UhfZKVoq3sAN>`_
 
 
 

diff --git a/docs/index.html b/docs/index.html
@@ -115,7 +115,10 @@ <h1>Model Tuner Documentation<a class="headerlink" href="#model-tuner-documentat
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Usage Guide</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="usage_guide.html">Usage Guide</a></li>
+<li class="toctree-l1"><a class="reference internal" href="usage_guide.html">Usage Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="usage_guide.html#ipython-notebooks">iPython Notebooks</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="usage_guide.html#key-methods-and-functionalities">Key Methods and Functionalities</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage_guide.html#helper-functions">Helper Functions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage_guide.html#notes">Notes</a></li>
@@ -128,7 +131,6 @@ <h1>Model Tuner Documentation<a class="headerlink" href="#model-tuner-documentat
 <li class="toctree-l2"><a class="reference internal" href="usage_guide.html#binary-classification-output">Binary Classification Output</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage_guide.html#regression">Regression</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usage_guide.html#regression-output">Regression Output</a></li>
-<li class="toctree-l2"><a class="reference internal" href="usage_guide.html#ipython-notebooks">iPython Notebooks</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/usage_guide.html b/docs/usage_guide.html
@@ -57,7 +57,10 @@
 </ul>
 <p class="caption" role="heading"><span class="caption-text">Usage Guide</span></p>
 <ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Usage Guide</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Usage Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#ipython-notebooks">iPython Notebooks</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="#key-methods-and-functionalities">Key Methods and Functionalities</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#helper-functions">Helper Functions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="#notes">Notes</a></li>
@@ -70,7 +73,6 @@
 <li class="toctree-l2"><a class="reference internal" href="#binary-classification-output">Binary Classification Output</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#regression">Regression</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#regression-output">Regression Output</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#ipython-notebooks">iPython Notebooks</a></li>
 </ul>
 </li>
 </ul>
@@ -116,6 +118,14 @@ <h1>Usage Guide<a class="headerlink" href="#id1" title="Link to this heading">
 <p class="admonition-title">Important</p>
 <p>This documentation is for <code class="docutils literal notranslate"><span class="pre">model_tuner</span></code> version <code class="docutils literal notranslate"><span class="pre">0.0.11a</span></code>.</p>
 </div>
+<section id="ipython-notebooks">
+<h2>iPython Notebooks<a class="headerlink" href="#ipython-notebooks" title="Link to this heading"></a></h2>
+<ul class="simple">
+<li><p><a class="reference external" href="https://colab.research.google.com/drive/1D9nl8rLdwxPEpiZplsU0I0lFSAec7NzP?authuser=1#scrollTo=tumIjsNpSAKC&amp;uniqifier=1">Binary Classification Example</a></p></li>
+<li><p><a class="reference external" href="https://colab.research.google.com/drive/1ujLL2mRtIWwGamnpWKIo2f271_Q103t-?usp=sharing#scrollTo=uMxyy0yvd2xQ">Column Transformer Example</a></p></li>
+<li><p><a class="reference external" href="https://colab.research.google.com/drive/151kdlsW-WyJ0pwwt_iWpjXDuqj1Ktam_?authuser=1#scrollTo=UhfZKVoq3sAN">Regression Example</a></p></li>
+</ul>
+</section>
 </section>
 <section id="key-methods-and-functionalities">
 <h1>Key Methods and Functionalities<a class="headerlink" href="#key-methods-and-functionalities" title="Link to this heading"></a></h1>
@@ -526,14 +536,6 @@ <h2>Regression Output<a class="headerlink" href="#regression-output" title="Link
 </pre></div>
 </div>
 </section>
-<section id="ipython-notebooks">
-<h2>iPython Notebooks<a class="headerlink" href="#ipython-notebooks" title="Link to this heading"></a></h2>
-<ul class="simple">
-<li><p><a class="reference external" href="https://colab.research.google.com/drive/1D9nl8rLdwxPEpiZplsU0I0lFSAec7NzP?authuser=1#scrollTo=tumIjsNpSAKC&amp;uniqifier=1">Binary Classification Example</a></p></li>
-<li><p><a class="reference external" href="https://colab.research.google.com/drive/1ujLL2mRtIWwGamnpWKIo2f271_Q103t-?usp=sharing#scrollTo=uMxyy0yvd2xQ">Column Transformer Example</a></p></li>
-<li><p><a class="reference external" href="https://colab.research.google.com/drive/151kdlsW-WyJ0pwwt_iWpjXDuqj1Ktam_?authuser=1#scrollTo=UhfZKVoq3sAN">Regression Example</a></p></li>
-</ul>
-</section>
 </section>
 
 

diff --git a/source/usage_guide.rst b/source/usage_guide.rst
@@ -30,6 +30,16 @@ Usage Guide
    This documentation is for ``model_tuner`` version ``0.0.11a``.
 
 
+iPython Notebooks
+--------------------
+
+- `Binary Classification Example <https://colab.research.google.com/drive/1D9nl8rLdwxPEpiZplsU0I0lFSAec7NzP?authuser=1#scrollTo=tumIjsNpSAKC&uniqifier=1>`_  
+
+- `Column Transformer Example <https://colab.research.google.com/drive/1ujLL2mRtIWwGamnpWKIo2f271_Q103t-?usp=sharing#scrollTo=uMxyy0yvd2xQ>`_
+
+- `Regression Example <https://colab.research.google.com/drive/151kdlsW-WyJ0pwwt_iWpjXDuqj1Ktam_?authuser=1#scrollTo=UhfZKVoq3sAN>`_
+
+
 Key Methods and Functionalities
 ========================================
 
@@ -511,14 +521,6 @@ Regression Output
    'AveOccup', 'Latitude', 'Longitude']}
 
 
-iPython Notebooks
---------------------
-
-- `Binary Classification Example <https://colab.research.google.com/drive/1D9nl8rLdwxPEpiZplsU0I0lFSAec7NzP?authuser=1#scrollTo=tumIjsNpSAKC&uniqifier=1>`_  
-
-- `Column Transformer Example <https://colab.research.google.com/drive/1ujLL2mRtIWwGamnpWKIo2f271_Q103t-?usp=sharing#scrollTo=uMxyy0yvd2xQ>`_
-
-- `Regression Example <https://colab.research.google.com/drive/151kdlsW-WyJ0pwwt_iWpjXDuqj1Ktam_?authuser=1#scrollTo=UhfZKVoq3sAN>`_