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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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

# Notebooks are authoring sources for the tutorial Markdown pages
# (regenerate via `poe notebooks`, which executes then exports); they are
# not part of the built site.
exclude_docs: |
  tutorials/*.ipynb

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
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: [pysrc]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            members_order: source

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - 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:
      - Overview & Running Locally: tutorials/index.md
      - Athens Quick Start: tutorials/01-athens-quickstart.md
      - Timeseries Analysis: tutorials/02-timeseries-analysis.md
      - Thermal Comfort: tutorials/03-thermal-comfort.md
      - Terrain Shadows (Bilbao): tutorials/04-bilbao-terrain-shadows.md
      - Ground Scheme (experimental): tutorials/05-ground-scheme-experimental.md
  - 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
      - Surface Views: guide/surface-views.md
      - Settings: guide/settings.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
      - Geospatial Helpers: api/geospatial.md
      - Errors: api/errors.md
  - Physics:
      - Overview: physics/index.md
      - Sky View Factor: physics/svf.md
      - Shadows: physics/shadows.md
      - Ground View Factor: physics/gvf.md
      - Radiation: physics/radiation.md
      - Ground Temperature: physics/ground_temperature.md
      - Mean Radiant Temperature: physics/tmrt.md
      - UTCI: physics/utci.md
      - PET: physics/pet.md
  - Development:
      - Contributing: development/contributing.md
  - About:
      - Release notes: about/changelog.md

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