pAMICA/mkdocs.yml at main · sccn/pAMICA · 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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# pAMICA documentation (MkDocs Material).
# Deployed to GitHub Pages by .github/workflows/docs.yml. The repo lives at
# github.com/sccn/pAMICA, whose project Pages inherit the sccn org Pages custom
# domain (eeglab.org) at the /pAMICA subpath, so the site is served at
# https://eeglab.org/pAMICA/. Links are relative so the build is location-independent.

site_name: pAMICA Documentation
site_url: https://eeglab.org/pAMICA/
site_description: Python (PyTorch) implementation of Adaptive Mixture ICA (AMICA) with Fortran parity and GPU/MPS/CPU support.
site_author: Seyed Yahya Shirazi

repo_url: https://github.com/sccn/pAMICA/
repo_name: sccn/pAMICA
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - navigation.instant
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - toc.integrate

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.arithmatex: # LaTeX math via MathJax (see extra_javascript below)
      generic: true
  - pymdownx.superfences
  - pymdownx.blocks.caption  # renders `/// caption` blocks under figures
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 3
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: numpy
            members_order: source
            filters: ["!^_"]
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true

# MathJax (LaTeX math) — see docs/javascripts/mathjax.js for the arithmatex hookup
extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Background:
      - Overview: concepts/index.md
      - What is ICA?: concepts/what-is-ica.md
      - What is AMICA?: concepts/what-is-amica.md
      - How AMICA works: concepts/how-amica-works.md
  - User Guide:
      - Overview: guides/index.md
      - Backends & Devices: guides/backends.md
      - EEGLAB interoperability: guides/eeglab.md
      - Validation & Parity: guides/validation.md
  - API Reference:
      - Overview: api/index.md
      - AMICA: api/amica.md
      - PyTorch backend: api/torch-backend.md
      - MLX backend: api/mlx-backend.md
      - NumPy backend: api/numpy-backend.md
      - Native backend: api/native-backend.md
      - MNE compatibility: api/mne-compat.md
      - Separation metrics: api/metrics.md
      - Visualization: api/viz.md
  - Development:
      - Contributing: development/contributing.md
      - Testing: development/testing.md
  - Changelog: changelog.md

copyright: Copyright &copy; 2023-2025 Seyed Yahya Shirazi