LEDStimulation/mkdocs.yml at main · SaleemLab/LEDStimulation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# Preset 4: ReadTheDocs Classic Theme
site_name: Full-Field LED Visual Stimulator
site_description: High-precision temporal visual stimulation platform for neuroscience and psychophysics.
site_author: Saleem Lab
repo_url: https://github.com/SaleemLab/LEDStimulation
repo_name: SaleemLab/LEDStimulation

theme:
  name: readthedocs
  highlightjs: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - tables
  - attr_list
  - md_in_html

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css
  - stylesheets/extra.css

extra_javascript:
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
  - javascripts/katex.js
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid.js

nav:
  - Overview: index.md
  - 1. Hardware:
      - Circuit & Driver: 1-hardware/circuit-and-driver.md
      - Custom PCBs: 1-hardware/custom-pcbs.md
      - Enclosure & Optics:
          - Panel Enclosure: 1-hardware/enclosure-and-optics/panel-enclosure.md
          - Wearable Glasses: 1-hardware/enclosure-and-optics/wearable-glasses.md
      - Bill of Materials: 1-hardware/bill-of-materials.md
  - 2. Firmware:
      - Architecture & Timers: 2-firmware/architecture-and-timers.md
      - Serial API Reference: 2-firmware/serial-api-reference.md
      - Firmware Variants: 2-firmware/firmware-variants.md
  - 3. Calibration:
      - Calibration Guide: 3-calibration/calibration-guide.md
      - Gamma LUT Pipeline: 3-calibration/gamma-lut-pipeline.md
      - Photoreceptor Calculations: 3-calibration/photoreceptor-calculations.md
  - 4. Experimental Workflows:
      - Bonsai Overview: 4-experimental-workflows/bonsai-overview.md
      - Stimulation Paradigms: 4-experimental-workflows/stimulation-paradigms.md
      - Integration & Sync: 4-experimental-workflows/integration-and-sync.md
  - 5. Reference:
      - Performance & Dynamics: 5-reference/performance-and-sync.md