echoSMs/mkdocs.yml at main · ices-tools-dev/echoSMs · 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
site_name: echoSMs
repo_url: https://github.com/ices-tools-dev/echoSMs
edit_uri: edit/main/docs/
site_url: https://ices-tools-dev.github.io/echoSMs/

nav:
    - Introduction: index.md
    - Using echoSMs: usage.md
    - Developing echoSMs: developing.md
    - Training:
        - Introduction: training/training.md
        - 2026 WGFAST workshop:
            - Introduction: training/2026 WGFAST workshop/overview.md
            - Model shapes: training/2026 WGFAST workshop/shapes.md
            - Using a model: training/2026 WGFAST workshop/models.md
            - Selecting a model: training/2026 WGFAST workshop/selecting.md
            - Workshop material: training/2026 WGFAST workshop/material.md
        - Links: training/links.md
    - Conventions: conventions.md
    - Benchmarks: benchmark_data.md
    - API reference: api_reference.md
    - Historical code & notes: historical_notes.md
    - Other software: other_software.md
    - Anatomical data store:
        - Introduction: datastore_intro.md
        - Data structures: datastore_anatomical.md
        - Schema: datastore_schema.md
        - Web API: datastore_API.md
        - Using with echoSMs: datastore_models.md

theme:
    name: material
    logo: resources/echoSMs_logo_auto_colour.svg
    favicon: resources/echoSMs_logo_auto_colour.svg
    icon:
        repo: fontawesome/brands/github
    features:
        - navigation.top
        - content.action.view
        - content.code.copy
        - search.suggest
        - search.highlight
        - search.share
    palette:
     # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
    - search
    - autorefs
    - mkdocstrings:
        handlers:
            python:
                paths: [src]
                options:
                    docstring_style: numpy
                    docstring_section_style: spacy
                    show_submodules: false
                    show_symbol_type_heading: true
                    show_symbol_type_toc: true
                    merge_init_into_class: true
                    show_bases: true
                    inherited_members: true
                    show_root_heading: true
                    show_root_toc_entry: false
                    show_source: true
                    heading_level: 3
                    filters:
                        - "!^_"

watch:
    - ./docs
    - ./src/echosms
    - ./data_store/schema/v1

# hooks:
    # - docs/src/make_datastore_schema_md.py
    # - docs/src/get_datastore_api_json.py

markdown_extensions:
    - attr_list
    - def_list
    - footnotes
    - tables
    - md_in_html
    - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
    - pymdownx.highlight
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - pymdownx.superfences
    - pymdownx.blocks.caption
    - admonition
    - pymdownx.details
    - pymdownx.tabbed:
        alternate_style: true

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js