eitprocessing/mkdocs.yml at main · EIT-ALIVE/eitprocessing · 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
site_name: eitprocessing
site_description: ALIVE project
strict: false

theme:
  name: "material"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: darkblue
      accent: pink
      toggle:
        icon: material/weather-sunny
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: darkblue
      accent: pink
      toggle:
        icon: material/weather-night
        name: "Switch to light mode"
  features:
    - announce.dismiss
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.indexes
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
  icon:
    logo: "material/home"
    next: fontawesome/solid/angle-right
    previous: fontawesome/solid/angle-left
    repo: fontawesome/brands/github-alt
    view: material/eye

repo_url: https://github.com/EIT-ALIVE/eitprocessing
repo_name: EIT-ALIVE/eitprocessing
edit_uri: edit/main/docs/

# Page tree
nav:
  - Home: index.md
  - Getting started:
      - installation.md
      - Example Notebooks:
        - examples/notebooks/test_ratedetection.ipynb
        - examples/notebooks/test_plot_filter_results.ipynb
        - examples/notebooks/test_watershed.ipynb
  - API Documentation:
      - api/loading.md
      - Data Containers:
        - Sequence: api/datacontainers/sequence.md
        - EITData: api/datacontainers/eitdata.md
        - ContinuousData: api/datacontainers/continuousdata.md
        - SparseData: api/datacontainers/sparsedata.md
        - IntervalData: api/datacontainers/intervaldata.md
        - PixelMap: api/datacontainers/pixelmap.md
        - Breath: api/datacontainers/breath.md
        - Event: api/datacontainers/event.md
        - DataCollection: api/datacontainers/datacollection.md
      - Features:
        - Breath Detection: api/features/breath_detection.md
        - Pixel Breath: api/features/pixel_breath.md
        - Rate Detection: api/features/rate_detection.md
        - Moving Average: api/features/moving_average.md
      - Filters:
        - Butterworth filters: api/filters/butterworth.md
        - MDN filter: api/filters/mdn.md
      - Regions of Interest:
        - Regions of Interest: api/roi/roi.md
        - FilterROIBySize: api/roi/filterbysize.md
        - PixelMaskCollection: api/roi/pixelmaskcollection.md
        - TIV and amplitude lung space: api/roi/tivlungspace.md
        - Watershed lung space: api/roi/watershed.md
      - api/parameters.md
      - api/categories.md
      - api/mixins.md
      - Plotting:
        - Rate Detection: api/plotting/rate_detection.md
        - PixelMap: api/plotting/pixelmap.md
        - Filter: api/plotting/filter.md
  - About:
      - Contributing: contributing_doc.md
      - Code of Conduct: code_of_conduct_doc.md
      - license_doc.md
      - team.md

extra:
  version:
    provider: mike

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: Page contents
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true
      default_lang: "py"
  - pymdownx.extra
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.magiclink
  - pymdownx.snippets:
      base_path: ["docs", "."]

watch:
  - docs

plugins:
  - mike:
      alias_type: symlink
      canonical_version: latest
  - search
  - exclude:
      glob:
        - __pycache__/*
  - autorefs
  - mkdocs-jupyter:
      ignore: ["**/ignore/*.ipynb", "**/ignore/*.py"]
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
            - https://docs.scipy.org/doc/scipy/objects.inv
            - https://pandas.pydata.org/docs/objects.inv
          options:
            members_order: source
            inherited_members: true
            filters: ["!^_"]
            merge_init_into_class: true
            show_root_heading: true
            show_root_full_path: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_submodules: true
            heading_level: 2
            show_bases: false
            show_source: false
            docstring_section_style: spacy
            line_length: 80

extra_css:
  - css/material.css