Skip to content

Commit

Permalink
Merge pull request #48 from bhawnasehgal/main
Browse files Browse the repository at this point in the history
Add appendices for pdfs, add open ephys course
  • Loading branch information
lorforlinux authored Aug 2, 2024
2 parents fd94832 + 814a85e commit 70d0c8f
Show file tree
Hide file tree
Showing 170 changed files with 2,996 additions and 514 deletions.
24 changes: 24 additions & 0 deletions _static/latex/bioamp-exg-pill.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:orphan:

BioAmp EXG Pill
###############

.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/bioamp-exg-pill/index


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst
24 changes: 24 additions & 0 deletions _static/latex/bioamp-v1.5.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:orphan:

BioAmp v1.5
##############

.. toctree::
:hidden:
:maxdepth: 3

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


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst
26 changes: 26 additions & 0 deletions _static/latex/diy-neuroscience-kit-basic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
:orphan:

DIY Neuroscience Kit Basic
###########################

.. toctree::
:hidden:
:maxdepth: 3

../../../kits/diy-neuroscience/basic/index


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst


39 changes: 39 additions & 0 deletions _static/latex/diy-neuroscience-kit-pro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
:orphan:

DIY Neuroscience Kit Pro
#########################

.. toctree::
:hidden:
:maxdepth: 3

../../../kits/diy-neuroscience/pro/index


.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/bioamp-exg-pill/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/muscle-bioamp-shield/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst

.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst


24 changes: 24 additions & 0 deletions _static/latex/muscle-bioamp-biscute.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:orphan:

Muscle BioAmp Biscute
#######################

.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/muscle-bioamp-biscute/index


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst
24 changes: 24 additions & 0 deletions _static/latex/muscle-bioamp-blip.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:orphan:

Muscle BioAmp Blip
####################

.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/muscle-bioamp-blip/index


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst
24 changes: 24 additions & 0 deletions _static/latex/muscle-bioamp-candy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:orphan:

Muscle BioAmp Candy
####################

.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/muscle-bioamp-candy/index


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst
18 changes: 18 additions & 0 deletions _static/latex/muscle-bioamp-patchy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:orphan:

Muscle BioAmp Patchy
####################

.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/muscle-bioamp-patchy/index


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst

23 changes: 23 additions & 0 deletions _static/latex/muscle-bioamp-shield.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
:orphan:

Muscle BioAmp Shield
#########################

.. toctree::
:hidden:
:maxdepth: 3

../../../hardware/bioamp/muscle-bioamp-shield/index

.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/skin-preparation/index.rst


.. toctree::
:hidden:
:maxdepth: 3

../../../guides/usage-guides/using-bioamp-bands/index.rst
3 changes: 1 addition & 2 deletions _templates/pdf.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{% for pdf_path in pdf_paths %}
{% for pdf_path, pdf_name in pdfs %}
{% if pdf_path+'/' in pagename %}
{% set pdf_name = pdf_path.split('/')[-1] %}
<a role="button" href="../../../{{pdf_name}}.pdf" target="_blank">
<i class="fa-solid fa-download"></i> Download PDF
</a>
Expand Down
13 changes: 0 additions & 13 deletions bioamp-exg-pill.rst

This file was deleted.

18 changes: 9 additions & 9 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

# Configure PDF build and sidebar links
latex_documents = []
pdf_paths = []
pdfs = []

with open('conf.yml', 'r') as conf_file:
conf_data = yaml.safe_load(conf_file)
Expand All @@ -34,18 +34,18 @@
pdf_build_all = False

for type, data in conf_data.items():
# Hardware
if(type == "hardware"):
for board, data in conf_data["hardware"].items():
# PDFs
if(type == "PDFs"):
for board, data in conf_data["PDFs"].items():
name = board
path = data['path']
pdf = data.get('pdf', False)

# PDF build details
if(pdf and (name in pdf_build or pdf_build_all)):
pdf_paths.append(path)
tex_name = path.split('/')[-1]
latex_documents.append((path+"/index", tex_name+".tex", "", author, "manual"))
tex_name = pdf.split('/')[-1]
pdfs.append((path, tex_name))
latex_documents.append((pdf, tex_name+".tex", "", author, "manual"))

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down Expand Up @@ -109,7 +109,7 @@
"name": "GeM India",
}
],
"header_links_before_dropdown": 5,
"header_links_before_dropdown": 6,
"show_prev_next": True,
"icon_links": [
{
Expand Down Expand Up @@ -180,7 +180,7 @@
"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",
"pdf_paths": pdf_paths
"pdfs": pdfs
}

# -- Options for LaTeX output --
Expand Down
24 changes: 15 additions & 9 deletions conf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,33 @@ pdf_build: all
# hardware:
# name:
# path: First level hardware documentation path for hardware 'index.rst'
# pdf: True/False (optional, False if this 'pdf:' option is not added)
# pdf: RST source for PDF generatation from _static/latex folder

hardware:
PDFs:
BioAmp EXG Pill:
path: hardware/bioamp/bioamp-exg-pill
pdf: True
pdf: _static/latex/bioamp-exg-pill
BioAmp v1.5:
path: hardware/bioamp/bioamp-v1.5
pdf: True
pdf: _static/latex/bioamp-v1.5
Muscle BioAmp BisCute:
path: hardware/bioamp/muscle-bioamp-biscute
pdf: True
pdf: _static/latex/muscle-bioamp-biscute
Muscle BioAmp Blip:
path: hardware/bioamp/muscle-bioamp-blip
pdf: True
pdf: _static/latex/muscle-bioamp-blip
Muscle BioAmp Candy:
path: hardware/bioamp/muscle-bioamp-candy
pdf: True
pdf: _static/latex/muscle-bioamp-candy
Muscle BioAmp Patchy:
path: hardware/bioamp/muscle-bioamp-patchy
pdf: True
pdf: _static/latex/muscle-bioamp-patchy
Muscle BioAmp Shield:
path: hardware/bioamp/muscle-bioamp-shield
pdf: True
pdf: _static/latex/muscle-bioamp-shield
DIY Neuroscience Kit Pro:
path: kits/diy-neuroscience/pro
pdf: _static/latex/diy-neuroscience-kit-pro
DIY Neuroscience Kit Basic:
path: kits/diy-neuroscience/basic
pdf: _static/latex/diy-neuroscience-kit-basic
12 changes: 12 additions & 0 deletions courses/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _upsidedownlabs_courses:

Courses
########

.. toctree::
:hidden:
:maxdepth: 1
:caption: Courses

open-ephys/index

Loading

0 comments on commit 70d0c8f

Please sign in to comment.