[docs] head

lastralab · Sep 19, 2024 · 1ed6c23 · 1ed6c23
1 parent ae1db0c
commit 1ed6c23
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 92 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,10 +7,12 @@ site_author: tanismo
 copyright: '© tanismo'
 edit_uri: blob/docs/docs
 nav:
-  - Getting Started: index.md
-  - Usage: abissmal.md
-  - About: about.md
-  - Github Collaboration: opensource.md
+  - Getting Started:
+    - Initial Setup: index.md
+    - Usage: abissmal.md
+  - About ABISSMAL:
+    - Project Overview: about.md
+    - Github Collaboration: opensource.md
 theme: readthedocs
 extra_css:
   - css/extra.css

diff --git a/site/404.html b/site/404.html
@@ -33,21 +33,19 @@
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption"><span class="caption-text">Getting Started</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/.">Getting Started</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/.">Initial Setup</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/abissmal/">Usage</a>
+                  </li>
               </ul>
+              <p class="caption"><span class="caption-text">About ABISSMAL</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/abissmal/">Usage</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/about/">About</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/opensource/">Github Collaboration</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/about/">Project Overview</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="/ABISSMAL/site/opensource/">Github Collaboration</a>
+                  </li>
               </ul>
       </div>
     </div>

diff --git a/site/abissmal/index.html b/site/abissmal/index.html
@@ -40,12 +40,11 @@
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="..">Getting Started</a>
-                </li>
-              </ul>
+              <p class="caption"><span class="caption-text">Getting Started</span></p>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="#">Usage</a>
+                  <li class="toctree-l1"><a class="reference internal" href="..">Initial Setup</a>
+                  </li>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Usage</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#ethics-statement">Ethics Statement</a>
     </li>
@@ -76,15 +75,14 @@
         </ul>
     </li>
     </ul>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../about/">About</a>
-                </li>
+                  </li>
               </ul>
+              <p class="caption"><span class="caption-text">About ABISSMAL</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../opensource/">Github Collaboration</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../about/">Project Overview</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../opensource/">Github Collaboration</a>
+                  </li>
               </ul>
       </div>
     </div>
@@ -100,6 +98,7 @@
         <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
+          <li class="breadcrumb-item">Getting Started</li>
       <li class="breadcrumb-item active">Usage</li>
     <li class="wy-breadcrumbs-aside">
           <a href="https://github.com/lastralab/ABISSMAL/blob/docs/docs/abissmal.md">Edit on ABISSMAL</a>
@@ -215,8 +214,8 @@ <h3 id="blank-display-with-tracking-system-running">Blank display with tracking
             </div>
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
-        <a href=".." class="btn btn-neutral float-left" title="Getting Started"><span class="icon icon-circle-arrow-left"></span> Previous</a>
-        <a href="../about/" class="btn btn-neutral float-right" title="About">Next <span class="icon icon-circle-arrow-right"></span></a>
+        <a href=".." class="btn btn-neutral float-left" title="Initial Setup"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../about/" class="btn btn-neutral float-right" title="Project Overview">Next <span class="icon icon-circle-arrow-right"></span></a>
     </div>
 
   <hr/>

diff --git a/site/about/index.html b/site/about/index.html
@@ -5,15 +5,15 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="tanismo" /><link rel="canonical" href="https://lastralab.github.io/ABISSMAL/site/about/" />
       <link rel="shortcut icon" href="../img/favicon.ico" />
-    <title>About - ABISSMAL Docs</title>
+    <title>Project Overview - ABISSMAL Docs</title>
     <link rel="stylesheet" href="../css/theme.css" />
     <link rel="stylesheet" href="../css/theme_extra.css" />
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
         <link href="../css/extra.css" rel="stylesheet" />
 
       <script>
         // Current page data
-        var mkdocs_page_name = "About";
+        var mkdocs_page_name = "Project Overview";
         var mkdocs_page_input_path = "about.md";
         var mkdocs_page_url = "/ABISSMAL/site/about/";
       </script>
@@ -40,16 +40,16 @@
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption"><span class="caption-text">Getting Started</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="..">Getting Started</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../abissmal/">Usage</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="..">Initial Setup</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../abissmal/">Usage</a>
+                  </li>
               </ul>
+              <p class="caption"><span class="caption-text">About ABISSMAL</span></p>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="#">About</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Project Overview</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#about">About</a>
     </li>
@@ -60,11 +60,9 @@
         </ul>
     </li>
     </ul>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../opensource/">Github Collaboration</a>
-                </li>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../opensource/">Github Collaboration</a>
+                  </li>
               </ul>
       </div>
     </div>
@@ -80,7 +78,8 @@
         <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
-      <li class="breadcrumb-item active">About</li>
+          <li class="breadcrumb-item">About ABISSMAL</li>
+      <li class="breadcrumb-item active">Project Overview</li>
     <li class="wy-breadcrumbs-aside">
           <a href="https://github.com/lastralab/ABISSMAL/blob/docs/docs/about.md">Edit on ABISSMAL</a>
     </li>

diff --git a/site/index.html b/site/index.html
@@ -3,17 +3,17 @@
 <head>
     <meta charset="utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="Automated Behavioral tracking by Integrating Sensors that Survey Movements Around a target Location" /><meta name="author" content="tanismo" /><link rel="canonical" href="https://lastralab.github.io/ABISSMAL/site/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="tanismo" /><link rel="canonical" href="https://lastralab.github.io/ABISSMAL/site/" />
       <link rel="shortcut icon" href="img/favicon.ico" />
-    <title>ABISSMAL Docs</title>
+    <title>Initial Setup - ABISSMAL Docs</title>
     <link rel="stylesheet" href="css/theme.css" />
     <link rel="stylesheet" href="css/theme_extra.css" />
         <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" />
         <link href="css/extra.css" rel="stylesheet" />
 
       <script>
         // Current page data
-        var mkdocs_page_name = "Getting Started";
+        var mkdocs_page_name = "Initial Setup";
         var mkdocs_page_input_path = "index.md";
         var mkdocs_page_url = "/ABISSMAL/site/";
       </script>
@@ -40,8 +40,9 @@
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption"><span class="caption-text">Getting Started</span></p>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="#">Getting Started</a>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Initial Setup</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#pre-requisites">Pre-requisites</a>
     </li>
@@ -50,19 +51,16 @@
     <li class="toctree-l2"><a class="reference internal" href="#directory-structure">Directory Structure</a>
     </li>
     </ul>
-                </li>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="abissmal/">Usage</a>
+                  </li>
               </ul>
+              <p class="caption"><span class="caption-text">About ABISSMAL</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="abissmal/">Usage</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="about/">About</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="opensource/">Github Collaboration</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="about/">Project Overview</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="opensource/">Github Collaboration</a>
+                  </li>
               </ul>
       </div>
     </div>
@@ -78,7 +76,8 @@
         <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
     <li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
-      <li class="breadcrumb-item active">Getting Started</li>
+          <li class="breadcrumb-item">Getting Started</li>
+      <li class="breadcrumb-item active">Initial Setup</li>
     <li class="wy-breadcrumbs-aside">
           <a href="https://github.com/lastralab/ABISSMAL/blob/docs/docs/index.md">Edit on ABISSMAL</a>
     </li>
@@ -195,8 +194,3 @@ <h2 id="directory-structure">Directory Structure</h2>
 
 </body>
 </html>
-
-<!--
-MkDocs version : 1.6.1
-Build Date UTC : 2024-09-19 20:01:57.268723+00:00
--->
diff --git a/site/opensource/index.html b/site/opensource/index.html
@@ -40,20 +40,18 @@
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption"><span class="caption-text">Getting Started</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="..">Getting Started</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../abissmal/">Usage</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="../about/">About</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="..">Initial Setup</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="../abissmal/">Usage</a>
+                  </li>
               </ul>
+              <p class="caption"><span class="caption-text">About ABISSMAL</span></p>
               <ul class="current">
-                <li class="toctree-l1 current"><a class="reference internal current" href="#">Github Collaboration</a>
+                  <li class="toctree-l1"><a class="reference internal" href="../about/">Project Overview</a>
+                  </li>
+                  <li class="toctree-l1 current"><a class="reference internal current" href="#">Github Collaboration</a>
     <ul class="current">
     <li class="toctree-l2"><a class="reference internal" href="#gitflow">Gitflow</a>
     </li>
@@ -62,7 +60,7 @@
     <li class="toctree-l2"><a class="reference internal" href="#new-collaborators">New collaborators</a>
     </li>
     </ul>
-                </li>
+                  </li>
               </ul>
       </div>
     </div>
@@ -78,6 +76,7 @@
         <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
   <ul class="wy-breadcrumbs">
     <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li>
+          <li class="breadcrumb-item">About ABISSMAL</li>
       <li class="breadcrumb-item active">Github Collaboration</li>
     <li class="wy-breadcrumbs-aside">
           <a href="https://github.com/lastralab/ABISSMAL/blob/docs/docs/opensource.md">Edit on ABISSMAL</a>
@@ -138,7 +137,7 @@ <h2>Setup Git credentials before cloning</h2>
             </div>
           </div><footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
-        <a href="../about/" class="btn btn-neutral float-left" title="About"><span class="icon icon-circle-arrow-left"></span> Previous</a>
+        <a href="../about/" class="btn btn-neutral float-left" title="Project Overview"><span class="icon icon-circle-arrow-left"></span> Previous</a>
     </div>
 
   <hr/>

diff --git a/site/search.html b/site/search.html
@@ -33,21 +33,19 @@
       </div>
 
       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption"><span class="caption-text">Getting Started</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="./.">Getting Started</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="./.">Initial Setup</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="./abissmal/">Usage</a>
+                  </li>
               </ul>
+              <p class="caption"><span class="caption-text">About ABISSMAL</span></p>
               <ul>
-                <li class="toctree-l1"><a class="reference internal" href="./abissmal/">Usage</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="./about/">About</a>
-                </li>
-              </ul>
-              <ul>
-                <li class="toctree-l1"><a class="reference internal" href="./opensource/">Github Collaboration</a>
-                </li>
+                  <li class="toctree-l1"><a class="reference internal" href="./about/">Project Overview</a>
+                  </li>
+                  <li class="toctree-l1"><a class="reference internal" href="./opensource/">Github Collaboration</a>
+                  </li>
               </ul>
       </div>
     </div>

diff --git a/site/search/search_index.json b/site/search/search_index.json