Make push-pages

Author: mvdoc

README.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" />
 
-    <title>&lt;no title&gt; &#8212; Voxelwise Encoding Model tutorials</title>
+    <title>How to build the tutorials website &#8212; Voxelwise Encoding Model tutorials</title>
 
 
 
@@ -32,7 +32,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=eba8b062" />
     <link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
-    <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
+    <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
     <link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
     <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
 
@@ -142,7 +142,7 @@
 
 
 
-<a class="navbar-brand logo" href="index.html">
+<a class="navbar-brand logo" href="pages/index.html">
 
 
 
@@ -174,32 +174,32 @@
 
         <ul class="nav bd-sidenav bd-sidenav__home-link">
             <li class="toctree-l1">
-                <a class="reference internal" href="index.html">
+                <a class="reference internal" href="pages/index.html">
                     Voxelwise Encoding Model (VEM) tutorials
                 </a>
             </li>
         </ul>
         <ul class="nav bd-sidenav">
-<li class="toctree-l1"><a class="reference internal" href="voxelwise_modeling.html">Overview of the VEM framework</a></li>
-<li class="toctree-l1"><a class="reference internal" href="voxelwise_package.html">Helper Python package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pages/voxelwise_modeling.html">Overview of the VEM framework</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="notebooks/shortclips/README.html">Shortclips tutorial</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/00_download_shortclips.html">Download the data set</a></li>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/01_plot_explainable_variance.html">Compute the explainable variance</a></li>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/02_plot_ridge_regression.html">Understand ridge regression and cross-validation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/03_plot_wordnet_model.html">Fit a ridge model with wordnet features</a></li>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/04_plot_hemodynamic_response.html">Visualize the hemodynamic response</a></li>
-<li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/05_plot_motion_energy_model.html">Fit a ridge model with motion energy features</a></li>
-<li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/06_plot_banded_ridge_model.html">Fit a banded ridge model with both wordnet and motion energy features</a></li>
-<li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/07_extract_motion_energy.html">Extract motion energy features from the stimuli</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/05_plot_motion_energy_model.html">Fit a ridge model with motion-energy features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/06_plot_banded_ridge_model.html">Fit a banded ridge model with both wordnet and motion-energy features</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/shortclips/07_extract_motion_energy.html">Extract motion-energy features from the stimuli</a></li>
 </ul>
 </details></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="notebooks/vim2/README.html">Vim-2 tutorial (optional)</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/vim2/00_download_vim2.html">Download the data set from CRCNS</a></li>
-<li class="toctree-l2"><a class="reference internal" href="notebooks/vim2/01_extract_motion_energy.html">Extract motion energy features from the stimuli</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/vim2/01_extract_motion_energy.html">Extract motion-energy features from the stimuli</a></li>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/vim2/02_plot_ridge_model.html">Fit a ridge model with motion energy features</a></li>
 </ul>
 </details></li>
-<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pages/references.html">References</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pages/voxelwise_package.html"><code class="docutils literal notranslate"><span class="pre">voxelwise_tutorials</span></code> helper package</a></li>
 </ul>
 
     </div>
@@ -301,7 +301,7 @@
 
 
 
-      <li><a href="_sources/README.rst" target="_blank"
+      <li><a href="_sources/README.md" target="_blank"
    class="btn btn-sm btn-download-source-button dropdown-item"
    title="Download source file"
    data-bs-placement="left" data-bs-toggle="tooltip"
@@ -311,7 +311,7 @@
 <span class="btn__icon-container">
   <i class="fas fa-file"></i>
   </span>
-<span class="btn__text-container">.rst</span>
+<span class="btn__text-container">.md</span>
 </a>
 </li>
 
@@ -385,7 +385,7 @@
 
 
 <div id="jb-print-docs-body" class="onlyprint">
-    <h1><no title></h1>
+    <h1>How to build the tutorials website</h1>
     <!-- Table of contents -->
     <div id="print-main-content">
         <div id="jb-print-toc">
@@ -394,9 +394,10 @@ <h1><no title></h1>
                 <h2> Contents </h2>
             </div>
             <nav aria-label="Page">
-                <ul class="simple visible nav section-nav flex-column">
+                <ul class="visible nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#build-the-website">Build the website</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#merge-notebooks">Merge notebooks</a></li>
 </ul>
-
             </nav>
         </div>
     </div>
@@ -407,8 +408,31 @@ <h2> Contents </h2>
 <div id="searchbox"></div>
                 <article class="bd-article">
 
-  <p>(If you are looking for some Jupyter notebooks, check the <a class="reference external" href="https://github.com/gallantlab/voxelwise_tutorials/tree/main/tutorials/notebooks">notebooks</a>
-directory.)</p>
+  <section class="tex2jax_ignore mathjax_ignore" id="how-to-build-the-tutorials-website">
+<h1>How to build the tutorials website<a class="headerlink" href="#how-to-build-the-tutorials-website" title="Link to this heading">#</a></h1>
+<p>Everything can be managed through the Makefile.
+The website is built using <code class="docutils literal notranslate"><span class="pre">jupyter-book</span></code>.
+Install all the required dependencies with:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="w">    </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/gallantlab/voxelwise_tutorials.git
+<span class="w">    </span><span class="nb">cd</span><span class="w"> </span>voxelwise_tutorials
+<span class="w">    </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span><span class="s2">&quot;.[github,docs]&quot;</span>
+</pre></div>
+</div>
+<section id="build-the-website">
+<h2>Build the website<a class="headerlink" href="#build-the-website" title="Link to this heading">#</a></h2>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>clean<span class="w">          </span><span class="c1"># Remove all files generated by the website build</span>
+make<span class="w"> </span>build<span class="w">          </span><span class="c1"># Build the website</span>
+make<span class="w"> </span>push-pages<span class="w">     </span><span class="c1"># Push the website to GitHub pages</span>
+</pre></div>
+</div>
+</section>
+<section id="merge-notebooks">
+<h2>Merge notebooks<a class="headerlink" href="#merge-notebooks" title="Link to this heading">#</a></h2>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make<span class="w"> </span>notebooks<span class="w">       </span><span class="c1"># Create a new version of the merged notebooks</span>
+</pre></div>
+</div>
+</section>
+</section>
 
     <script type="text/x-thebe-config">
     {
@@ -455,9 +479,10 @@ <h2> Contents </h2>
     <i class="fa-solid fa-list"></i> Contents
   </div>
   <nav class="bd-toc-nav page-toc">
-    <ul class="simple visible nav section-nav flex-column">
+    <ul class="visible nav section-nav flex-column">
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#build-the-website">Build the website</a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#merge-notebooks">Merge notebooks</a></li>
 </ul>
-
   </nav></div>
 
 </div></div>