qseek/mkdocs.yml at main · pyrocko/qseek · 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
site_name: "Earthqake Detection and Localization"
site_description: Lightning-fast earthquake detection and localization for large-data.
site_author: Marius Isken

repo_url: https://github.com/pyrocko/qseek
repo_name: pyrocko/qeek
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/theme
  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: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/git-alt
  logo: images/logo-white.webp
  features:
    - navigation.tabs
    - search.suggest
    - announce.dismiss
    - content.code.copy
    - content.action.edit

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.blocks.caption
  - pymdownx.snippets
  - pymdownx.tilde
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

  - pymdownx.details
  - pymdownx.tasklist
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - def_list
  - attr_list

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

watch:
  - src/qseek

plugins:
  - search
  - markdown-exec
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
            - https://numpy.org/doc/stable/objects.inv
          options:
            extensions:
              - griffe_pydantic:
                  schema: false
            inherited_members: true
            show_signature_annotations: true
            show_symbol_type_toc: true
            separate_signature: true
            show_root_heading: true
            show_source: false
            show_symbol_type_heading: true
            signature_crossrefs: true
            summary: true

nav:
  - Home:
      - Welcome: index.md
      - Quick Start 🚀: getting_started.md
      - Visualising Detections: visualizing_results.md
      - Benchmark: benchmark.md
  - Configuration:
      - The Search: components/configuration.md
      - Search Volume: components/octree.md
      - Metadata: components/station_metadata.md
      - Waveforms: components/waveform_data.md
      - Ray Tracers: components/ray_tracer.md
      - Phase Annotation: components/image_function.md
      - Distance Weighting: components/distance_weighting.md
      - Magnitudes: components/magnitudes.md
      - Station Corrections: components/station_corrections.md
      - General Configuration: components/general.md
  - Reference:
      - API Overview: api/overview.md
      - Models: api/models.md
      - Stations: api/stations.md
      - Octree: api/octree.md
      - Ray Tracer: api/ray_tracer.md
      - Utils: api/utils.md