Improved docs

README.md

@@ -2,6 +2,7 @@
 
 [![](https://img.shields.io/badge/docs-quarto-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEMAAABDCAMAAADwFEhBAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAB2lBMVEUAAABxvP90vP9zu/90u/90u/90u/90u/91uv91vP9zuv91v/91uv91u/9zvP90u/90uv92uv+As/91u/91u/90u/90u/90vP+Aqv90u/91u/9zuv90uf90u/90u/90u/9zuf9ttv90u/90u/91vP8A//92uv90u/95tv9zuv90u/90vP9zuv90u/91uv91u/90u/90vP90uf9zvP90u/93vv90u/90u/93u/9qv/90u/9zu/91vP90u/90vP95vP9Vqv90u/90u/91u/90u/90uf+Av/91u/90u/9xvf90u/91vP92vv90u/+AgP90u/9zu/91vP9vvP90u/90uv90u/94tP90u/9zvP90uv90u/90u/91u/90vP9zu/90uv91u/90uv9zvP9zuv9xu/9zvP90u/90u/90vP9zvP90uf9xxv90u/90uv90u/9zvf90u/90u/90u/90uv91uv90vP90uf90u/91vP90u/9wuP9zu/9zvP9zuv90u/92v/90uv90vP9yvP90uv90u/9mzP91u/90vP90u/92vP90vP9zvP90u/90u/90u/90u/9yuv91uv90u/91vP91u/90u/90u/9zu/91vf90u/90u/91u/90u//////Zz6urAAAAnHRSTlMAImOdxOv+4LqQWRgwjt/NdxoKadL8uUQGcOjJTUvbvygOpfh2ATTaFV3kLnPvP4P3ckJb8Cv12Q8M16ibWjkTA8+VYvshBJdWG8OBJ+ICfzyMF9FR/RGERauW9LHBvqfHhp9vLTWwqWdUFgm1kU8f+taeXCWIC+FI7BmHUInVHOO9JraiBa9950HMaulA5chOVbQ9pObcUiN1k23io9BOAAAAAWJLR0SdBrvysQAAAAd0SU1FB+cIFgIIE8103aAAAAEhelRYdFJhdyBwcm9maWxlIHR5cGUgeG1wAAAokXVSS3LFIAzbc4oegcjGJsdJH7DrTJc9fmWSvqR5LZ78bCNLIunr4zO9xRJIkodX2bxa82zNiqstyPFtD+suUZMG2GJqw2BFtj3/7B4AcjphmHyPLaVqKxlZxYZzI7IUdFFeGZCeN+QIUgDBTbYC1aR2m78Xg0N1ZWTZOHP4XOjOJvQ5wjFkkTUCI0kWMAHe2w7Cp/hKWNL2ihYDonxyuTNStZJcTJhYp7SVLnQyPBroCzibTgRDGvEL6Bpe00VUANlfsianftrNd/pnjYKPPSFtmSaOV+pPAT8DNg1nViuH7EOBdDr1SCfq/413bzCu7uzmpKs716M9m+Nw1aI2sy9/XVTSN0+AmxnAMJeGAAAAAW9yTlQBz6J3mgAAAipJREFUWMPt11lb00AYBeDPhXGDVpEiorhQKkWsglYFrRJFq6KiAkpVXFHR1qXuirvivqK4nx9r0tRCIEln5rvlXOXi5L3Ikzl5QuSVKVOnTS8BrEuIGTNnzZ5DaiktC8BOzshFBOfOkwbK51egkFHDTKhygZRQtbAa8DDMLFpcnKhZAvgZwNJl/sLyWqCYgXBdxIdYUQ8JA6iMehINYcgZWNnoQawSkDUQW+1KrAHkDTTVuBDNUDLQtHYCsU4oGoivH0c0boCqgY0tDqJ1E9QNbHYYCegY2DKG2Cr0jJK2AmFsg56B7QWjHbrGjp15IhnQNrArb+yGvhHeYxsdDAN7c8Q+cIz9nVbjAMvAQasR5BmHzEKX4BndZqEHPOPwEaJepoEU0VGu0UxUwTWOER3nGn1kgGucoMk4YwjuMz1JVM01ThGd5hpniM5yjQaifq5xjug804ibY2jEeMYFqzHAMy5ajUssI5S2GpkYx7hsv6pXOMZV27iW1Teud+bPzA194+b/c3crq2vUJwuH97aukRodgDt39YyBsStyT+gY9wcdU/RAwxAPnXOW7FA3Ho3fxOhjVaPPmDCsT56qGc8yLuv8PKBivCh3nfjBbnlj6KXHd6LllaQReu39VxjpD8sYb96SX0rfFTdqo+Sf5PsP/kbwIxVPa90nb+Pzl4gEYaZq+GvWzYgnvskBdtLtI9+dxo/Ez4yKYOdXz+8/Q9bFSNnfVFr9fpX8A/gO4x9ExakgAAAAUGVYSWZNTQAqAAAACAACARIAAwAAAAEAAQAAh2kABAAAAAEAAAAmAAAAAAADoAEAAwAAAAEAAQAAoAIABAAAAAEAAABDoAMABAAAAAEAAABDAAAAAEC2TfoAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMDgtMjJUMDI6MDg6MTgrMDA6MDDjF9jVAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTA4LTIyVDAyOjA4OjE4KzAwOjAwkkpgaQAAACh0RVh0ZGF0ZTp0aW1lc3RhbXAAMjAyMy0wOC0yMlQwMjowODoxOSswMDowMGMoSgIAAAARdEVYdGV4aWY6Q29sb3JTcGFjZQAxD5sCSQAAABJ0RVh0ZXhpZjpFeGlmT2Zmc2V0ADM4rbi+IwAAABd0RVh0ZXhpZjpQaXhlbFhEaW1lbnNpb24ANjeFsWfdAAAAF3RFWHRleGlmOlBpeGVsWURpbWVuc2lvbgA2N1gnvlgAAAASdEVYdHRpZmY6T3JpZW50YXRpb24AMber/DsAAAAASUVORK5CYII=)](https://peekxc.github.io/simplextree-py/pages/)
 [![coverage_badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/peekxc/ef42349965f40edf4232737026690c5f/raw/coverage_info.json)](https://coveralls.io/github/peekxc/simplextree-py) [![build_macos](https://img.shields.io/github/actions/workflow/status/peekxc/simplextree-py/build_macos.yml?logo=apple&logoColor=white)](https://github.com/peekxc/simplextree-py/actions/workflows/build-macos.yml) [![build_windows](https://img.shields.io/github/actions/workflow/status/peekxc/simplextree-py/build_windows.yml?logo=windows&logoColor=white)](https://github.com/peekxc/simplextree-py/actions/workflows/build-windows.yml) [![build_linux](https://img.shields.io/github/actions/workflow/status/peekxc/simplextree-py/build_linux.yml?logo=linux&logoColor=white)](https://github.com/peekxc/simplextree-py/actions/workflows/build-linux.yml)
+[![PyPI Version](https://img.shields.io/pypi/v/simplextree)](https://pypi.org/project/simplextree)
 
 `simplextree` is an Python package that simplifies computation for general [simplicial complexes](https://en.wikipedia.org/wiki/Simplicial_complex) of any dimension by providing [pybind11](https://github.com/pybind/pybind11) bindings to a *Simplex Tree* data structure implemented in modern C++17.
 

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.html" class="sidebar-item-text sidebar-link">
+            <a href="../reference/index.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../reference/SimplexTree.SimplexTree.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>
@@ -231,7 +231,6 @@ <h1 class="title">simplextree</h1>
 
 </header>
 
-<p><a href="https://coveralls.io/github/peekxc/simplextree-py"><img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/peekxc/ef42349965f40edf4232737026690c5f/raw/coverage_info.json" class="img-fluid" alt="coverage_badge"></a> <a href="https://github.com/peekxc/simplextree-py/actions/workflows/build-macos.yml"><img src="https://img.shields.io/github/actions/workflow/status/peekxc/simplextree-py/build_macos.yml?logo=apple&amp;logoColor=white" class="img-fluid" alt="build_macos"></a> <a href="https://github.com/peekxc/simplextree-py/actions/workflows/build-windows.yml"><img src="https://img.shields.io/github/actions/workflow/status/peekxc/simplextree-py/build_windows.yml?logo=windows&amp;logoColor=white" class="img-fluid" alt="build_windows"></a> <a href="https://github.com/peekxc/simplextree-py/actions/workflows/build-linux.yml"><img src="https://img.shields.io/github/actions/workflow/status/peekxc/simplextree-py/build_linux.yml?logo=linux&amp;logoColor=white" class="img-fluid" alt="build_linux"></a></p>
 <p><code>simplextree</code> is an Python package that simplifies computation for general <a href="https://en.wikipedia.org/wiki/Simplicial_complex">simplicial complexes</a> of any dimension by providing <a href="https://github.com/pybind/pybind11">pybind11</a> bindings to a <em>Simplex Tree</em> data structure implemented in modern C++17.</p>
 <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">

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.html" rel="next">
+<link href="../reference/index.qmd" 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.html" class="sidebar-item-text sidebar-link">
+            <a href="../reference/index.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../reference/SimplexTree.SimplexTree.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>
@@ -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.html" class="pagination-link">
+      <a href="../reference/index.qmd" class="pagination-link">
         <span class="nav-page-text">API Reference</span> <i class="bi bi-arrow-right-short"></i>
       </a>
   </div>

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.html" class="sidebar-item-text sidebar-link">
+            <a href="../reference/index.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../reference/SimplexTree.SimplexTree.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>

docs/pages/reference/SimplexTree.SimplexTree.html

@@ -156,7 +156,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../../reference/index.html" class="sidebar-item-text sidebar-link">
+            <a href="../../reference/index.qmd" 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 +165,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.html" class="sidebar-item-text sidebar-link">
+  <a href="../../reference/SimplexTree.SimplexTree.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>

docs/pages/reference/UnionFind.UnionFind.html

@@ -140,7 +140,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../../reference/index.html" class="sidebar-item-text sidebar-link">
+            <a href="../../reference/index.qmd" 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 +149,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.html" class="sidebar-item-text sidebar-link">
+  <a href="../../reference/SimplexTree.SimplexTree.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>

docs/pages/reference/index.html

@@ -140,7 +140,7 @@
 </li>
         <li class="sidebar-item sidebar-item-section">
       <div class="sidebar-item-container"> 
-            <a href="../../reference/index.html" class="sidebar-item-text sidebar-link">
+            <a href="../../reference/index.qmd" 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 +149,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.html" class="sidebar-item-text sidebar-link">
+  <a href="../../reference/SimplexTree.SimplexTree.qmd" 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.html" class="sidebar-item-text sidebar-link">
+  <a href="../../reference/UnionFind.UnionFind.qmd" class="sidebar-item-text sidebar-link">
  <span class="menu-text">Union Find</span></a>
   </div>
 </li>