Update documentation

NGSolve · Jun 14, 2024 · c6ed0f2 · c6ed0f2
1 parent 9cf1be8
commit c6ed0f2
Show file tree

Hide file tree

Showing 9 changed files with 69 additions and 80 deletions.
diff --git a/Madeline/notebook_workshop_vienna.html b/Madeline/notebook_workshop_vienna.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; NGSolve 24</title>
+    <title>5. Madeline &#8212; NGSolve 24</title>
 
 
 
@@ -32,7 +32,7 @@
     <link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=384b581d" />
     <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" />
+    <link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
     <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=87e54e7c" />
 
@@ -170,11 +170,12 @@
                 </a>
             </li>
         </ul>
-        <ul class="nav bd-sidenav">
+        <ul class="current nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../Siyar/graphene_nano_ribbon_toymodel.html">1. Solve the non-linear Poisson equation for a graphene nano ribbon</a></li>
 
 <li class="toctree-l1"><a class="reference internal" href="../SebastianP/ViscoElasticShell_NGS24.html">3. Viscoelastic Shell formulation using HHJ Method</a></li>
 
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">5. Madeline</a></li>
 </ul>
 
     </div>
@@ -315,9 +316,7 @@
   </button>
 `);
 </script>
-<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
-    <span class="fa-solid fa-list"></span>
-</label>
+
 </div></div>
 
     </div>
@@ -328,19 +327,11 @@
 
 
 <div id="jb-print-docs-body" class="onlyprint">
-    <h1><no title></h1>
+    <h1>Madeline</h1>
     <!-- Table of contents -->
     <div id="print-main-content">
         <div id="jb-print-toc">
 
-            <div>
-                <h2> Contents </h2>
-            </div>
-            <nav aria-label="Page">
-                <ul class="simple visible nav section-nav flex-column">
-</ul>
-
-            </nav>
         </div>
     </div>
 </div>
@@ -350,7 +341,9 @@ <h2> Contents </h2>
 <div id="searchbox"></div>
                 <article class="bd-article">
 
-  <div class="cell docutils container">
+  <section class="tex2jax_ignore mathjax_ignore" id="madeline">
+<h1><span class="section-number">5. </span>Madeline<a class="headerlink" href="#madeline" title="Link to this heading">#</a></h1>
+<div class="cell docutils container">
 <div class="cell_input docutils container">
 <div class="highlight-ipython3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">netgen.geom2d</span> <span class="kn">import</span> <span class="n">CSG2d</span><span class="p">,</span> <span class="n">Circle</span><span class="p">,</span> <span class="n">Rectangle</span>
 <span class="kn">from</span> <span class="nn">ngsolve</span> <span class="kn">import</span> <span class="o">*</span>
@@ -1216,6 +1209,7 @@ <h2> Contents </h2>
 </div>
 </div>
 </div>
+</section>
 
     <script type="text/x-thebe-config">
     {
@@ -1263,21 +1257,6 @@ <h2> Contents </h2>
 
 
 
-                <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
-
-
-  <div class="sidebar-secondary-item">
-  <div class="page-toc tocsection onthispage">
-    <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>
-
-  </nav></div>
-
-</div></div>
-
 
           </div>
           <footer class="bd-footer-content">

diff --git a/README.html b/README.html
@@ -32,7 +32,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=384b581d" />
     <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" />
+    <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
     <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=87e54e7c" />
 
@@ -176,6 +176,7 @@
 
 <li class="toctree-l1"><a class="reference internal" href="SebastianP/ViscoElasticShell_NGS24.html">3. Viscoelastic Shell formulation using HHJ Method</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="Madeline/notebook_workshop_vienna.html">5. Madeline</a></li>
 </ul>
 
     </div>
@@ -345,7 +346,24 @@ <h1>ngs24blitz</h1>
 <h1>ngs24blitz<a class="headerlink" href="#ngs24blitz" title="Link to this heading">#</a></h1>
 <p>Contributions are found here:
 <a class="reference external" href="https://ngsolve.github.io/ngs24blitz/">https://ngsolve.github.io/ngs24blitz/</a></p>
-<p>ghp-import -n -p -f _build/html</p>
+<ul>
+<li><p>clone the project:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/NGSolve/ngs24blitz.git
+</pre></div>
+</div>
+</li>
+<li><p>build the jupyter-book locally:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>jupyter-book build .
+</pre></div>
+</div>
+</li>
+<li><p>deploy the built book to gh-pages:</p>
+<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ghp-import -n -p -f _build/html
+</pre></div>
+</div>
+</li>
+</ul>
+<p>jupyter-books: <a class="reference external" href="https://jupyterbook.org/en/stable/start/overview.html">https://jupyterbook.org/en/stable/start/overview.html</a></p>
 </section>
 
     <script type="text/x-thebe-config">

diff --git a/_sources/Madeline/notebook_workshop_vienna.ipynb b/_sources/Madeline/notebook_workshop_vienna.ipynb
diff --git a/_sources/README.md b/_sources/README.md
@@ -3,4 +3,16 @@
 Contributions are found here:
 https://ngsolve.github.io/ngs24blitz/
 
-ghp-import -n -p -f _build/html
+* clone the project:
+
+      git clone https://github.com/NGSolve/ngs24blitz.git
+
+* build the jupyter-book locally:
+
+      jupyter-book build .
+
+* deploy the built book to gh-pages:
+
+      ghp-import -n -p -f _build/html
+
+jupyter-books: https://jupyterbook.org/en/stable/start/overview.html
diff --git a/genindex.html b/genindex.html
@@ -31,7 +31,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=384b581d" />
     <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" />
+    <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
     <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=87e54e7c" />
 
@@ -175,6 +175,7 @@
 
 <li class="toctree-l1"><a class="reference internal" href="SebastianP/ViscoElasticShell_NGS24.html">3. Viscoelastic Shell formulation using HHJ Method</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="Madeline/notebook_workshop_vienna.html">5. Madeline</a></li>
 </ul>
 
     </div>

diff --git a/intro.html b/intro.html
@@ -32,7 +32,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=384b581d" />
     <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" />
+    <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
     <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=87e54e7c" />
 
@@ -179,6 +179,7 @@
 
 <li class="toctree-l1"><a class="reference internal" href="SebastianP/ViscoElasticShell_NGS24.html">3. Viscoelastic Shell formulation using HHJ Method</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="Madeline/notebook_workshop_vienna.html">5. Madeline</a></li>
 </ul>
 
     </div>
@@ -353,6 +354,7 @@ <h1>NGSolve 24<a class="headerlink" href="#ngsolve-24" title="Link to this headi
 <li class="toctree-l1"><a class="reference internal" href="Siyar/graphene_nano_ribbon_toymodel.html#constants-and-functions">2. Constants and Functions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="SebastianP/ViscoElasticShell_NGS24.html">3. Viscoelastic Shell formulation using HHJ Method</a></li>
 <li class="toctree-l1"><a class="reference internal" href="SebastianP/ViscoElasticShell_NGS24.html#model-problem">4. Model Problem</a></li>
+<li class="toctree-l1"><a class="reference internal" href="Madeline/notebook_workshop_vienna.html">5. Madeline</a></li>
 </ul>
 </div>
 </section>

diff --git a/objects.inv b/objects.inv
diff --git a/search.html b/search.html
@@ -30,7 +30,7 @@
     <link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=384b581d" />
     <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" />
+    <link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
     <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=87e54e7c" />
 
@@ -177,6 +177,7 @@
 
 <li class="toctree-l1"><a class="reference internal" href="SebastianP/ViscoElasticShell_NGS24.html">3. Viscoelastic Shell formulation using HHJ Method</a></li>
 
+<li class="toctree-l1"><a class="reference internal" href="Madeline/notebook_workshop_vienna.html">5. Madeline</a></li>
 </ul>
 
     </div>

diff --git a/searchindex.js b/searchindex.js