Starting docs overhaul

peekxc · Nov 13, 2024 · 0bc6ade · 0bc6ade
1 parent 9ca8d2c
commit 0bc6ade
Show file tree

Hide file tree

Showing 47 changed files with 6,782 additions and 1,603 deletions.
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -10,10 +10,10 @@ metadata-files:
 
 website: 
   navbar:
-    title: PRIMATE2
+    title: PRIMATE
     right: 
       - icon: github
-        href: https://github.com/peekxc/primate2
+        href: https://github.com/peekxc/primate
         aria-label: GitHub
     left:
       - file: reference/index.qmd
@@ -26,6 +26,7 @@ website:
     copy-button: true
 
   sidebar:
+    file: "_sidebar.yml"
     search: true
     style: floating
     border: false
@@ -36,36 +37,17 @@ website:
         contents:
           - text: Comparison to *imate*
             href: imate_compare.qmd
-      - section: API Reference 
-        href: reference/index.qmd
+      - section: "API Reference"
         contents:
-          - section: Estimators
-            contents: 
-              - reference/estimators.hutch.qmd
-          - section: Operators
-            contents:
-              - reference/operators.MatrixFunction.qmd
-              - reference/operators.Toeplitz.qmd
-              - reference/operators.normalize_unit.qmd
-          - section: Stochastic
-            contents:
-              - reference/stochastic.isotropic.qmd
-              - reference/stochastic.symmetric.qmd
-              - reference/stats.confidence_interval.qmd
-              - reference/stats.MeanEstimatorCLT.qmd
-          - section: Lanczos
-            contents: 
-              - reference/lanczos.lanczos.qmd
-              - reference/lanczos.rayleigh_ritz.qmd
-              - reference/quadrature.lanczos_quadrature.qmd
+          - "{{ contents }}"
   reader-mode: true     # reader mode collapses sidebar 
   page-navigation: true # ability to go to next / prev 
   page-footer: "Copyright 2024, Matt Piekenbrock" 
 
 quartodoc:
   package: null
-  # package: primate2
-  source_dir: ../src/primate2
+  # package: primate
+  source_dir: ../src/primate
   sidebar: _sidebar.yml
   out_index: index.qmd
   parser: google
@@ -83,13 +65,19 @@ quartodoc:
       contents:
         - stochastic.isotropic
         - stochastic.symmetric
-        - stats.confidence_interval
-        - stats.MeanEstimatorCLT
     - title: Lanczos
       contents: 
         - lanczos.lanczos
         - lanczos.rayleigh_ritz
         - quadrature.lanczos_quadrature
+        # - quadrature.spectral_density
+    - title: Stats
+      contents: 
+        - stats.Covariance
+        - stats.ConvergenceEstimator
+        - stats.MeanEstimator
+        - stats.CentralLimitEstimator
+        - stats.ControlVariableEstimator
 
 filters:
   - pseudocode  

diff --git a/docs/_sidebar.yml b/docs/_sidebar.yml
@@ -13,13 +13,18 @@ website:
     - contents:
       - reference/stochastic.isotropic.qmd
       - reference/stochastic.symmetric.qmd
-      - reference/stats.confidence_interval.qmd
-      - reference/stats.MeanEstimatorCLT.qmd
       section: Stochastic
     - contents:
       - reference/lanczos.lanczos.qmd
       - reference/lanczos.rayleigh_ritz.qmd
       - reference/quadrature.lanczos_quadrature.qmd
       section: Lanczos
+    - contents:
+      - reference/stats.Covariance.qmd
+      - reference/stats.ConvergenceEstimator.qmd
+      - reference/stats.MeanEstimator.qmd
+      - reference/stats.CentralLimitEstimator.qmd
+      - reference/stats.ControlVariableEstimator.qmd
+      section: Stats
     id: reference
   - id: dummy-sidebar
diff --git a/docs/_site/imate_compare.html b/docs/_site/imate_compare.html
@@ -30,7 +30,6 @@
 <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="./index.html" rel="prev">
 <script src="site_libs/quarto-html/quarto.js"></script>
 <script src="site_libs/quarto-html/popper.min.js"></script>
@@ -126,7 +125,7 @@
       <div class="navbar-container container-fluid">
       <div class="navbar-brand-container mx-auto">
     <a class="navbar-brand" href="./index.html">
-    <span class="navbar-title">PRIMATE2</span>
+    <span class="navbar-title">PRIMATE</span>
     </a>
   </div>
             <div id="quarto-search" class="" title="Search"></div>
@@ -136,13 +135,13 @@
           <div class="collapse navbar-collapse" id="navbarCollapse">
             <ul class="navbar-nav navbar-nav-scroll me-auto">
   <li class="nav-item">
-    <a class="nav-link active" href="./reference/index.html" aria-current="page"> 
+    <a class="nav-link" href="./reference/index.html"> 
 <span class="menu-text">Reference</span></a>
   </li>  
 </ul>
             <ul class="navbar-nav navbar-nav-scroll ms-auto">
   <li class="nav-item compact">
-    <a class="nav-link" href="https://github.com/peekxc/primate2"> <i class="bi bi-github" role="img" aria-label="GitHub">
+    <a class="nav-link" href="https://github.com/peekxc/primate"> <i class="bi bi-github" role="img" aria-label="GitHub">
 </i> 
 <span class="menu-text"></span></a>
   </li>  
@@ -208,122 +207,15 @@
   </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 class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" role="navigation" aria-expanded="true">
  <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-2" role="navigation" aria-expanded="true" aria-label="Toggle section">
             <i class="bi bi-chevron-right ms-2"></i>
           </a> 
       </div>
       <ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">  
-          <li class="sidebar-item sidebar-item-section">
-      <div class="sidebar-item-container"> 
-            <a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="false">
- <span class="menu-text">Estimators</span></a>
-          <a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" role="navigation" aria-expanded="false" aria-label="Toggle section">
-            <i class="bi bi-chevron-right ms-2"></i>
-          </a> 
-      </div>
-      <ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth2 ">  
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/estimators.hutch.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">estimators.hutch</span></a>
-  </div>
-</li>
-      </ul>
-  </li>
-          <li class="sidebar-item sidebar-item-section">
-      <div class="sidebar-item-container"> 
-            <a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="false">
- <span class="menu-text">Operators</span></a>
-          <a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-4" role="navigation" aria-expanded="false" aria-label="Toggle section">
-            <i class="bi bi-chevron-right ms-2"></i>
-          </a> 
-      </div>
-      <ul id="quarto-sidebar-section-4" class="collapse list-unstyled sidebar-section depth2 ">  
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/operators.MatrixFunction.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">operators.MatrixFunction</span></a>
-  </div>
-</li>
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/operators.Toeplitz.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">operators.Toeplitz</span></a>
-  </div>
-</li>
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/operators.normalize_unit.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">operators.normalize_unit</span></a>
-  </div>
-</li>
-      </ul>
-  </li>
-          <li class="sidebar-item sidebar-item-section">
-      <div class="sidebar-item-container"> 
-            <a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="false">
- <span class="menu-text">Stochastic</span></a>
-          <a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-5" role="navigation" aria-expanded="false" aria-label="Toggle section">
-            <i class="bi bi-chevron-right ms-2"></i>
-          </a> 
-      </div>
-      <ul id="quarto-sidebar-section-5" class="collapse list-unstyled sidebar-section depth2 ">  
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/stochastic.isotropic.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">stochastic.isotropic</span></a>
-  </div>
-</li>
           <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/stochastic.symmetric.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">stochastic.symmetric</span></a>
-  </div>
-</li>
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/stats.confidence_interval.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">stats.confidence_interval</span></a>
-  </div>
-</li>
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/stats.MeanEstimatorCLT.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">stats.MeanEstimatorCLT</span></a>
-  </div>
-</li>
-      </ul>
-  </li>
-          <li class="sidebar-item sidebar-item-section">
-      <div class="sidebar-item-container"> 
-            <a class="sidebar-item-text sidebar-link text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="false">
- <span class="menu-text">Lanczos</span></a>
-          <a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-6" role="navigation" aria-expanded="false" aria-label="Toggle section">
-            <i class="bi bi-chevron-right ms-2"></i>
-          </a> 
-      </div>
-      <ul id="quarto-sidebar-section-6" class="collapse list-unstyled sidebar-section depth2 ">  
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/lanczos.lanczos.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">lanczos.lanczos</span></a>
-  </div>
-</li>
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/lanczos.rayleigh_ritz.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">lanczos.rayleigh_ritz</span></a>
-  </div>
-</li>
-          <li class="sidebar-item">
-  <div class="sidebar-item-container"> 
-  <a href="./reference/quadrature.lanczos_quadrature.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">quadrature.lanczos_quadrature</span></a>
-  </div>
-</li>
-      </ul>
+ <span class="menu-text">{{ contents }}</span>
   </li>
       </ul>
   </li>
@@ -1003,9 +895,6 @@ <h1 class="title">Comparison to <code>imate</code></h1>
       </a>          
   </div>
   <div class="nav-page nav-page-next">
-      <a href="./reference/index.html" class="pagination-link" aria-label="API Reference">
-        <span class="nav-page-text">API Reference</span> <i class="bi bi-arrow-right-short"></i>
-      </a>
   </div>
 </nav>
 </div> <!-- /content -->