Merge pull request upsidedownlabs#26 from lorforlinux/main

Add PDF download link and GeM India store link

_templates/pdf.html

@@ -0,0 +1,8 @@
+{% for hardware_part_path in hardware_part_paths %}
+    {% if hardware_part_path+'/' in pagename %}
+        {% set pdf_name = hardware_part_path.split('/')[-1] %}
+        <a role="button" href="{{docs_url}}/{{pdf_name}}.pdf" target="_blank">
+            <i class="fa-solid fa-download"></i> Download PDF
+        </a>
+    {% endif %}
+{% endfor %}

bioamp-exg-pill.rst

@@ -7,7 +7,7 @@ BioAmp EXG Pill
 
 .. toctree::
    :hidden:
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: BioAmp
 
-   bioamp/hardware/bioamp-exg-pill/index
+   hardware/bioamp/bioamp-exg-pill/index

conf.py

@@ -6,6 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+import os
 import sys
 from pathlib import Path
 from typing import Any, Dict
@@ -18,6 +19,16 @@
 copyright = '2024, Upside Down Labs'
 author = 'Upside Down Labs'
 
+# Hardware structure names
+hardware_part_paths = []
+for (hardware_dirpath, hardware_dirnames, hardware_filenames) in os.walk("hardware"):
+    for hardware_dirname in hardware_dirnames:
+        for (part_dirpath, part_dirnames, part_filenames) in os.walk(hardware_dirpath+'/'+hardware_dirname):
+            for part_dirname in part_dirnames:
+                hardware_part_paths.append(part_dirpath+'/'+part_dirname)
+            break
+    break
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
@@ -72,9 +83,13 @@
         {
             "url": "https://store.upsidedownlabs.tech/",
             "name": "Store India",
+        },
+{
+            "url": "https://t.ly/ExlaF",
+            "name": "GeM India",
         }
     ],
-    "header_links_before_dropdown": 1,
+    "header_links_before_dropdown": 3,
     "show_prev_next": True,
     "icon_links": [
         {
@@ -119,9 +134,9 @@
     "footer_start": ["copyright"],
     "footer_end": ["last-updated"],
     # "content_footer_items": ["last-updated"],
-    # "secondary_sidebar_items": {
-    #     "**": ["page-toc", "edit-this-page", "sourcelink","pdf"]
-    # }
+    "secondary_sidebar_items": {
+        "**": ["page-toc", "edit-this-page", "sourcelink","pdf"]
+    }
 }
 
 html_context = {
@@ -138,8 +153,12 @@
     "edit_page_url_template": "{{ my_vcs_site }}{{ file_name }}",
     "edit_page_provider_name": "GitHub",
     "my_vcs_site": "https://github.com/upsidedownlabs/upsidedownlabs.github.io/edit/main",
+    "hardware_part_paths": hardware_part_paths
 }
 
-latex_documents = [
-    ("bioamp-exg-pill", "bioamp-exg-pill.tex", "BioAmp EXG Pill", author, "manual"),
-]
+# -- Options for LaTeX output --
+latex_documents = []
+
+for hardware_part_path in hardware_part_paths:
+    board_tex_name = hardware_part_path.split('/')[-1]
+    latex_documents.append((hardware_part_path+"/index", board_tex_name+".tex", "", author, "manual"))

bioamp/experiments/index.rst → experiments/index.rst

@@ -1,7 +1,7 @@
-.. _bioamp-experiments:
+.. _upsidedownlabs-experiments:
 
-BioAmp Experiments
-###################
+Experiments
+#############
 
 .. toctree::
    :hidden:

bioamp/hardware/bioamp-v1.5/index.rst → hardware/bioamp/bioamp-v1.5/index.rst

@@ -24,7 +24,7 @@ Features & Specifications
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Minimum Input Voltage | 7-9 V                                                                                                                                                            |
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Input Impedance       | ≥10^7 ohm                                                                                                                                                        |
+| Input Impedance       | 10^7 ohm                                                                                                                                                         |
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Fixed Gain            | ~200x                                                                                                                                                            |
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+

hardware/index.rst

@@ -0,0 +1,17 @@
+.. _upsidedownlabs_hardware_home:
+
+Hardware
+########
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: BioAmp Hardware
+
+   bioamp/bioamp-exg-pill/index
+   bioamp/muscle-bioamp-shield/index
+   bioamp/muscle-bioamp-patchy/index
+   bioamp/muscle-bioamp-blip/index
+   bioamp/bioamp-v1.5/index
+   bioamp/muscle-bioamp-candy/index
+   bioamp/muscle-bioamp-biscute/index

index.rst

@@ -6,8 +6,10 @@
 :html_theme.sidebar_secondary.remove: true
 :sd_hide_title: true
 
+.. _upsidedownlabs_docs_home:
+
 Welcome to Upside Down Labs docs's documentation!
-=================================================
+##################################################
 
 .. figure:: media/banner.*
    :align: center
@@ -97,61 +99,23 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor i
 
             BioAmp EXG Pill 
 
-.. .. admonition:: BeagleBoard.org background
-   
-..    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-
-.. Research Papers using our hardware
-.. ************************************
-
-.. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-
-.. Be a part of our community
-.. ******************************
-
-.. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-
-.. Contribute
-.. ****************************************
-
-.. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-
-.. Know more about us!
-.. ********************
-
-.. .. grid:: 1 1 3 3
-..     :margin: 4 4 0 0 
-..     :gutter: 2
-
-..     .. grid-item::
-        
-..         .. card::
-
-            
-..             :fas:`person-circle-question` **WHY**
-..             ^^^^^
-..             We believe in making DIY Neuroscience affordable and accessible to all. 
-
-..     .. grid-item::
-        
-..         .. card::
-            
-..             :fas:`person-digging` **HOW**
-..             ^^^^^
-..             By providing DIY Neuroscience Kits to students and researchers to make innovative HCI and BCI. 
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Hardware
 
-..     .. grid-item::
-        
-..         .. card::
+   hardware/index
 
-..             :fas:`person-circle-check` **WHAT**
-..             ^^^^^
-..             We build novel, open source hardware & software with detailed documentation.  
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Software
 
+   software/index
 
 .. toctree::
    :hidden:
-   :maxdepth: 2
-   :caption: BioAmp
+   :maxdepth: 1
+   :caption: Experiments
 
-   bioamp/index
+   experiments/index

software/index.rst

@@ -0,0 +1,14 @@
+.. _upsidedownlabs_software_home:
+
+Software
+########
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: BioAmp Software
+
+   bioamp/muscle-bioamp-arduino-firmware/index
+   bioamp/eye-bioamp-arduino-firmware/index
+   bioamp/heart-bioamp-arduino-firmware/index
+   bioamp/brain-bioamp-arduino-firmware/index