docsite changes

peekxc · Aug 23, 2023 · d235ba5 · d235ba5
1 parent 598bfe8
commit d235ba5
Show file tree

Hide file tree

Showing 18 changed files with 76 additions and 2,052 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 A *Simplex Tree* is an ordered, [trie](https://en.wikipedia.org/wiki/Trie)-like structure whose nodes are in bijection with the faces of the complex. Here's a picture of a simplicial 3-complex (left) and its corresponding Simplex Tree (right):
 
-![simplex tree picture](./docs/pages/static/simplextree_pic.png)
+![simplex tree picture](./docs/static/simplextree.png)
 
 The *Simplex Tree* was originally introduced in the following paper:
 

diff --git a/docs/pages/index.html b/docs/pages/index.html
@@ -174,7 +174,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../reference/index.qmd" class="sidebar-item-text sidebar-link">
+            <a href="../pages/reference/index.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">API Reference</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
@@ -183,13 +183,13 @@
       <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">  
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../reference/SimplexTree.SimplexTree.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../pages/reference/SimplexTree.SimplexTree.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Simplex Tree</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../pages/reference/UnionFind.UnionFind.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>
@@ -235,7 +235,7 @@ <h1 class="title">simplextree</h1>
 <p>A <em>Simplex Tree</em> is an ordered, <a href="https://en.wikipedia.org/wiki/Trie">trie</a>-like structure whose nodes are in bijection with the faces of the complex. Here’s a picture of a simplicial 3-complex (left) and its corresponding Simplex Tree (right):</p>
 <div class="quarto-figure quarto-figure-center">
 <figure class="figure">
-<p><img src="./static/simplextree_pic.png" class="preview-image img-fluid figure-img"></p>
+<p><img src="../static/simplextree.png" class="preview-image img-fluid figure-img"></p>
 <figcaption class="figure-caption">Picture taken from Boissonnat et al: “The simplex tree: An efficient data structure for general simplicial complexes”</figcaption>
 </figure>
 </div>

diff --git a/docs/pages/overview.html b/docs/pages/overview.html
@@ -64,7 +64,7 @@
 <script src="../site_libs/quarto-search/fuse.min.js"></script>
 <script src="../site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="../">
-<link href="../reference/index.qmd" rel="next">
+<link href="../pages/reference/index.html" rel="next">
 <link href="../pages/quickstart.html" rel="prev">
 <script src="../site_libs/quarto-html/quarto.js"></script>
 <script src="../site_libs/quarto-html/popper.min.js"></script>
@@ -192,7 +192,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../reference/index.qmd" class="sidebar-item-text sidebar-link">
+            <a href="../pages/reference/index.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">API Reference</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
@@ -201,13 +201,13 @@
       <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">  
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../reference/SimplexTree.SimplexTree.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../pages/reference/SimplexTree.SimplexTree.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Simplex Tree</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../pages/reference/UnionFind.UnionFind.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>
@@ -250,12 +250,12 @@ <h1 class="title">Overview of the <code>simplextree</code> package</h1>
 <p>Like graphs, there are many ways to represent simplicial complexes in memory. One such way is to use a <em>Simplex Tree</em>: an ordered, <a href="https://en.wikipedia.org/wiki/Trie">trie</a>-like structure whose nodes are in bijection with the faces of the complex. Here’s a picture of a simplicial 3-complex (left) and its corresponding Simplex Tree (right):</p>
 <div class="quarto-figure quarto-figure-center">
 <figure class="figure">
-<p><img src="./static/simplextree_pic.png" class="preview-image img-fluid figure-img"></p>
+<p><img src="../static/simplextree.png" class="preview-image img-fluid figure-img"></p>
 <figcaption class="figure-caption">Picture taken from Boissonnat et al: “The simplex tree: An efficient data structure for general simplicial complexes”</figcaption>
 </figure>
 </div>
 <p>To construct the complex above with a <code>simplextree</code> package, simply give the maximal simplices:</p>
-<div class="cell" data-execution_count="1">
+<div class="cell" data-execution_count="2">
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> simplextree <span class="im">import</span> SimplexTree</span>
 <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>st <span class="op">=</span> SimplexTree([[<span class="dv">1</span>,<span class="dv">2</span>,<span class="dv">3</span>],[<span class="dv">2</span>,<span class="dv">3</span>,<span class="dv">4</span>,<span class="dv">5</span>],[<span class="dv">6</span>,<span class="dv">7</span>,<span class="dv">9</span>],[<span class="dv">7</span>,<span class="dv">8</span>],[<span class="dv">10</span>]]) <span class="co"># complex form the picture</span></span>
 <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(st)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
@@ -264,7 +264,7 @@ <h1 class="title">Overview of the <code>simplextree</code> package</h1>
 </div>
 </div>
 <p>To look at the tree structure, use <code>print_tree</code> (see also: <code>print_cousins</code>)</p>
-<div class="cell" data-execution_count="2">
+<div class="cell" data-execution_count="3">
 <div class="sourceCode cell-code" id="cb3"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a>st.print_tree()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <div class="cell-output cell-output-stdout">
 <pre><code>1 (h = 2): .( 2 3 )..( 3 )
@@ -280,7 +280,7 @@ <h1 class="title">Overview of the <code>simplextree</code> package</h1>
 </div>
 </div>
 <p>To maintain fast coface lookup and enumeration, extra links are added between nodes at the same level, which are shown by the dash-dotted lines in the figure above (only for the nodes with the label <span class="math inline">5</span>). To view these links with the <code>SimplexTree</code> class, use <code>print_cousins()</code>:</p>
-<div class="cell" data-execution_count="3">
+<div class="cell" data-execution_count="4">
 <div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>st.print_cousins()</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <div class="cell-output cell-output-stdout">
 <pre><code>(last=2, depth=2): { 1 2 } 
@@ -657,7 +657,7 @@ <h1 class="title">Overview of the <code>simplextree</code> package</h1>
       </a>          
   </div>
   <div class="nav-page nav-page-next">
-      <a href="../reference/index.qmd" class="pagination-link">
+      <a href="../pages/reference/index.html" class="pagination-link">
         <span class="nav-page-text">API Reference</span> <i class="bi bi-arrow-right-short"></i>
       </a>
   </div>

diff --git a/docs/pages/quickstart.html b/docs/pages/quickstart.html
@@ -191,7 +191,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../reference/index.qmd" class="sidebar-item-text sidebar-link">
+            <a href="../pages/reference/index.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">API Reference</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
@@ -200,13 +200,13 @@
       <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">  
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../reference/SimplexTree.SimplexTree.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../pages/reference/SimplexTree.SimplexTree.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Simplex Tree</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../pages/reference/UnionFind.UnionFind.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>

diff --git a/docs/pages/reference/SimplexTree.SimplexTree.html b/docs/pages/reference/SimplexTree.SimplexTree.html
@@ -30,6 +30,8 @@
 <script src="../../site_libs/quarto-search/fuse.min.js"></script>
 <script src="../../site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="../../">
+<link href="../../pages/reference/UnionFind.UnionFind.html" rel="next">
+<link href="../../pages/reference/index.html" rel="prev">
 <script src="../../site_libs/quarto-html/quarto.js"></script>
 <script src="../../site_libs/quarto-html/popper.min.js"></script>
 <script src="../../site_libs/quarto-html/tippy.umd.min.js"></script>
@@ -122,7 +124,7 @@
       <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
         <i class="bi bi-layout-text-sidebar-reverse"></i>
       </button>
-      <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"></ol></nav>
+      <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../pages/reference/index.html">API Reference</a></li><li class="breadcrumb-item"><a href="../../pages/reference/SimplexTree.SimplexTree.html">Simplex Tree</a></li></ol></nav>
       <a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">      
       </a>
       <button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
@@ -156,7 +158,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../../reference/index.qmd" class="sidebar-item-text sidebar-link">
+            <a href="../../pages/reference/index.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">API Reference</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
@@ -165,13 +167,13 @@
       <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">  
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../../reference/SimplexTree.SimplexTree.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../../pages/reference/SimplexTree.SimplexTree.html" class="sidebar-item-text sidebar-link active">
  <span class="menu-text">Simplex Tree</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../../pages/reference/UnionFind.UnionFind.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>
@@ -977,6 +979,18 @@ <h4 class="anchored" data-anchor-id="parameters-8">Parameters</h4>
   }
 });
 </script>
+<nav class="page-navigation">
+  <div class="nav-page nav-page-previous">
+      <a href="../../pages/reference/index.html" class="pagination-link">
+        <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">API Reference</span>
+      </a>          
+  </div>
+  <div class="nav-page nav-page-next">
+      <a href="../../pages/reference/UnionFind.UnionFind.html" class="pagination-link">
+        <span class="nav-page-text">Union Find</span> <i class="bi bi-arrow-right-short"></i>
+      </a>
+  </div>
+</nav>
 </div> <!-- /content -->
 <footer class="footer">
   <div class="nav-footer">

diff --git a/docs/pages/reference/UnionFind.UnionFind.html b/docs/pages/reference/UnionFind.UnionFind.html
@@ -30,6 +30,7 @@
 <script src="../../site_libs/quarto-search/fuse.min.js"></script>
 <script src="../../site_libs/quarto-search/quarto-search.js"></script>
 <meta name="quarto:offset" content="../../">
+<link href="../../pages/reference/SimplexTree.SimplexTree.html" rel="prev">
 <script src="../../site_libs/quarto-html/quarto.js"></script>
 <script src="../../site_libs/quarto-html/popper.min.js"></script>
 <script src="../../site_libs/quarto-html/tippy.umd.min.js"></script>
@@ -106,7 +107,7 @@
       <button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
         <i class="bi bi-layout-text-sidebar-reverse"></i>
       </button>
-      <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"></ol></nav>
+      <nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../../pages/reference/index.html">API Reference</a></li><li class="breadcrumb-item"><a href="../../pages/reference/UnionFind.UnionFind.html">Union Find</a></li></ol></nav>
       <a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">      
       </a>
       <button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
@@ -140,7 +141,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../../reference/index.qmd" class="sidebar-item-text sidebar-link">
+            <a href="../../pages/reference/index.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">API Reference</span></a>
           <a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
@@ -149,13 +150,13 @@
       <ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">  
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../../reference/SimplexTree.SimplexTree.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../../pages/reference/SimplexTree.SimplexTree.html" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Simplex Tree</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
+  <a href="../../pages/reference/UnionFind.UnionFind.html" class="sidebar-item-text sidebar-link active">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>
@@ -537,6 +538,15 @@ <h1>UnionFind.UnionFind</h1>
   }
 });
 </script>
+<nav class="page-navigation">
+  <div class="nav-page nav-page-previous">
+      <a href="../../pages/reference/SimplexTree.SimplexTree.html" class="pagination-link">
+        <i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Simplex Tree</span>
+      </a>          
+  </div>
+  <div class="nav-page nav-page-next">
+  </div>
+</nav>
 </div> <!-- /content -->
 <footer class="footer">
   <div class="nav-footer">