biosiglib/mkdocs.yml at main · BSICoS/biosiglib · 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
site_name: Biosiglib
site_description: Language-independent specifications and conformance resources for reproducible biomedical signal processing.
repo_url: https://github.com/BSICoS/biosiglib
repo_name: BSICoS/biosiglib

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
  palette:
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

plugins:
  - search

hooks:
  - tools/generate_docs.py

nav:
  - Home: index.md
  - Methods:
      - Overview: methods/index.md
      - ECG:
          - Baseline removal: methods/ecg.baselineremove.md
          - Pan-Tompkins detector: methods/ecg.pantompkins.md
          - Slope-range respiration: methods/ecg.sloperange.md
      - HRV:
          - Frequency-domain metrics: methods/hrv.fdmetrics.md
          - Gap filling: methods/hrv.fillgaps.md
          - IPFM reconstruction: methods/hrv.ipfm.md
          - Orthogonal subspace projection: methods/hrv.osp.md
          - False-positive removal: methods/hrv.removefp.md
          - Time-domain metrics: methods/hrv.tdmetrics.md
      - Utilities:
          - LPD filter: methods/tools.lpd_filter.md
          - Median-filter threshold: methods/tools.medfilt_threshold.md
          - NaN-aware filter: methods/tools.nan_filter.md
          - NaN-aware zero-phase filter: methods/tools.nan_filtfilt.md
          - Snap to peak: methods/tools.snap_to_peak.md
  - Implementations: implementations.md
  - Cite: citation.md

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true