openseize/mkdocs.yml at master · mscaudill/openseize · 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
site_name: OPENSEIZE

# custom color scheme
extra_css:
    - stylesheets/extra_styles.css

# declare plugins
plugins:
    - search
    - mkdocstrings:
        handlers:
            python:
                paths: [src]
                options:
                    members_order: source
    - mkdocs-jupyter

# declare extensions
markdown_extensions:
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences

# use standard material theme
theme:
    name: material

    # two toggleable color palettes
    palette:
        - scheme: space
          toggle:
            icon: material/brightness-7
            name: Dark Mode

        - scheme: slate
          primary: black
          toggle:
              icon: material/brightness-4
              name: Light Mode

    # logos at site name & window tab
    logo: 'imgs/tinylogo.png'
    favicon: 'imgs/tinylogo.png'

    features:
        # add tabs to header & keep visible on scroll
        - navigation.tabs
        - navigation.tabs.sticky

    # add icon to header for github repo link
    icon:
        repo: fontawesome/brands/github

# link to github repository
repo_url: https://github.com/mscaudill/openseize
repo_name: mscaudill/openseize

# make pages non-editable
edit_uri: ""

# configure navigation pane
nav:
    - Home: index.md
    - Quickstart: quickstart.ipynb
    - Tutorials:
        - 'Producers': 'tutorials/producers.ipynb'
        - 'File Reading':
          - 'EDF Format': 'tutorials/edf_format.ipynb'
          - 'Other Formats': 'tutorials/other_formats.ipynb'
        - 'Filtering': 'tutorials/filtering.ipynb'
        - 'Resampling': 'tutorials/resampling.ipynb'
        - 'Fourier Transform': 'tutorials/fourier_transform.ipynb'
        - 'Spectral Analysis': 'tutorials/spectra.ipynb'
    - Reference:
        - Producers:
          - producer: 'producer/producer.md'
        - 'File IO':
          - 'Dialogs': 'file_io/dialogs.md'
          - EDF:
            - Introduction: 'file_io/edf/edf_intro.md'
            - Reader: 'file_io/edf/edf_reader.md'
            - Writer: 'file_io/edf/edf_writer.md'
            - Splitter: 'file_io/edf/edf_splitter.md'
          - Annotations:
            - Introduction: 'file_io/annotations/ann_intro.md'
            - Pinnacle: 'file_io/annotations/pinnacle.md'
            - as_mask: 'file_io/annotations/as_mask.md'
        - Filters:
            - 'FIR Filters':
              - Introduction: 'filtering/firs/fir_intro.md'
              - Kaiser: 'filtering/firs/kaiser.md'
              - Rectangular: 'filtering/firs/rectangular.md'
              - Bartlett: 'filtering/firs/bartlett.md'
              - Hann: 'filtering/firs/hann.md'
              - Hamming: 'filtering/firs/hamming.md'
              - Blackman: 'filtering/firs/blackman.md'
              - Remez: 'filtering/firs/remez.md'
            - 'IIR Filters':
              - Introduction: 'filtering/iirs/iir_intro.md'
              - Butterworth: 'filtering/iirs/butter.md'
              - 'Chebyshev I': 'filtering/iirs/cheby1.md'
              - 'Chebyshev II': 'filtering/iirs/cheby2.md'
              - Elliptical: 'filtering/iirs/ellip.md'
              - Notch: 'filtering/iirs/notch.md'
            - 'Special':
              - Hilbert: 'filtering/special/hilbert.md'
        - Resampling:
            - Resampling: 'resampling/resampling.md'
        - Spectra:
            - Estimators:
              - Power Spectrum: 'spectra/estimators/psd.md'
              - Short-time Fourier Transform: 'spectra/estimators/stft.md'
            - Metrics: 'spectra/spectra_metrics.md'
            - Plotting: 'spectra/spectra_plotting.md'

    - About: about.md

# reflect changes immediately during dev.
watch:
    - src/openseize/

# Footer icon components
extra:
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/mscaudill