swim-rs/mkdocs.yml at main · dgketchum/swim-rs · 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
site_name: SWIM-RS
site_description: Soil Water Inverse Modeling with Remote Sensing
site_url: https://swim-rs.readthedocs.io
repo_url: https://github.com/dgketchum/swim-rs
repo_name: dgketchum/swim-rs

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.sections
    - navigation.expand
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - header.autohide

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            docstring_style: google

markdown_extensions:
  - tables
  - fenced_code
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.arithmatex:
      generic: true
  - admonition
  - pymdownx.details
  - toc:
      permalink: true

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js

nav:
  - Home: index.md
  - Installation: installation.md
  - How-To Guide: how_to.md
  - Data Extraction Guide: data_extraction.md
  - Algorithm Description: algorithm_description.md
  - ET-Demands Comparison: et-demands-compare.md
  - Architecture:
      - Process Package: process_architecture.md
      - Container: container_architecture.md
  - API Reference:
      - Overview: api/index.md
      - Container: api/container.md
      - Process: api/process.md
      - Calibrate: api/calibrate.md
      - Data Extraction: api/data_extraction.md
      - Swim (Config): api/swim.md
      - Legacy: api/legacy.md
  - CLI Cheat Sheet: swim_cli_cheatsheet.md