pySWATPlus/mkdocs.yml at main · swat-model/pySWATPlus · 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
site_name: pySWATPlus
theme:
  name: material
  features:
    - navigation.tabs
    - content.code.annotate
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_signature_annotations: true
            show_root_heading: true
            show_root_full_path: false
            filters:
              - "!^_[^_]"  # exclude members starting with a single underscore, but keep __init__, __str__, etc.

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details

nav:
  - Home: index.md

  - User Guide:
    - SWAT+ Simulation: userguide/swatplus_simulation.md
    - Sensitivity Interface: userguide/sensitivity_interface.md
    - Advanced Sensitivity: userguide/advanced_sensitivity.md
    - Model Calibration: userguide/model_calibration.md
    - Advanced Calibration: userguide/advanced_calibration.md
    - Data Analysis: userguide/data_analysis.md

  - API Reference:
    - TxtinoutReader: api/txtinout_reader.md
    - PerformanceMetrics: api/performance_metrics.md
    - SensitivityAnalyzer: api/sensitivity_analyzer.md
    - Calibration: api/calibration.md
    - DataManager: api/data_manager.md

  - Contributor Guide: CONTRIBUTING.md

  - Release Notes: changelog.md