codameter/mkdocs.yml at master · Denolle-Lab/codameter · 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
site_name: codameter
site_description: Operational pipeline for interpreting seismic velocity changes (dv/v) as stress and strain meters
site_url: https://denolle-lab.github.io/codameter/
repo_url: https://github.com/Denolle-Lab/codameter
repo_name: Denolle-Lab/codameter

theme:
  name: material
  features:
    - navigation.instant
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.suggest
    - content.code.copy
    - content.tabs.link
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Installation: installation.md
  - Quickstart: quickstart.md
  - Six-phase workflow: workflow.md
  - Theory pointer: theory.md
  - Examples:
    - examples/parkfield.md
    - examples/clements_denolle_2023.md
  - API reference:
    - api/index.md
    - High-level: api/high_level.md
    - Forward models: api/forward.md
    - Coupling: api/coupling.md
    - Inversion: api/inverse.md
  - Known issues: known_issues.md
  - Changelog: changelog.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            show_signature_annotations: true
            members_order: source
            heading_level: 3

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: true
  - tables

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js