solweig/mkdocs.yml at main · UMEP-dev/solweig · 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
site_name: SOLWEIG
site_description: High-performance urban microclimate model for Mean Radiant Temperature and thermal comfort
site_url: https://umep-dev.github.io/solweig/
repo_url: https://github.com/UMEP-dev/solweig
repo_name: UMEP-dev/solweig

theme:
  name: material
  palette:
    - scheme: default
      primary: blue grey
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [pysrc]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            members_order: source
  - mkdocs-jupyter:
      execute: false
      include_source: true

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - tables
  - toc:
      permalink: true

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

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quick-start.md
      - Installation: getting-started/installation.md
  - Tutorials:
      - Athens Quick Start: tutorials/01-athens-quickstart.ipynb
      - Timeseries Analysis: tutorials/02-timeseries-analysis.ipynb
      - Thermal Comfort: tutorials/03-thermal-comfort.ipynb
      - Terrain Shadows (Bilbao): tutorials/04-bilbao-terrain-shadows.ipynb
  - User Guide:
      - Basic Usage: guide/basic-usage.md
      - Working with GeoTIFFs: guide/geotiffs.md
      - Timeseries Calculations: guide/timeseries.md
      - Thermal Comfort (UTCI/PET): guide/thermal-comfort.md
      - QGIS Plugin: guide/qgis-plugin.md
      - Configuration: PARAMS_SIMPLE.md
      - Reproducibility: RUN_METADATA.md
  - API Reference:
      - Overview: api/index.md
      - Core Functions: api/functions.md
      - Data Classes: api/dataclasses.md
      - I/O Functions: api/io.md
      - Errors: api/errors.md
  - Physics:
      - Overview: physics/index.md
  - Development:
      - Contributing: development/contributing.md
      - Architecture: development/architecture.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/UMEP-dev/solweig