climdata/mkdocs.yml at main · Kaushikreddym/climdata · 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
site_name: climdata
site_description: This project automates the fetching, extraction and processing of weather data from multiple sources — such as MSWX, DWD HYRAS, ERA5-Land, NASA-NEX-GDDP, and more — for a given location and time range.
site_author: Kaushikreddym
site_url: https://Kaushikreddym.github.io/climdata
repo_url: https://github.com/Kaushikreddym/climdata

copyright: "Copyright &copy; 2024 - 2024 Kaushik Muduchuru"

# Running the example notebooks leaves working artifacts beside them: a conf/
# copy dropped by _ensure_local_conf(), and data/ holding the downloads (HYRAS
# alone is several GB). Both are gitignored, but mkdocs copies anything under
# docs/ into the site verbatim — which fills the build disk and takes minutes.
# Excluding them here is what keeps `mkdocs build` fast and small.
exclude_docs: |
  examples/**/data/
  examples/**/conf/
  examples/climdata_cli.py

theme:
    palette:
        - scheme: default
          primary: light green
        #   toggle:
        #       icon: material/toggle-switch-off-outline
        #       name: Switch to dark mode
        # - scheme: slate
        #   primary: light green
        #   accent: indigo
        #   toggle:
        #       icon: material/toggle-switch
        #       name: Switch to light mode
    name: material
    logo: assets/climdata_logo.png
    icon:
        repo: fontawesome/brands/github
    custom_dir: "docs/overrides"
    font:
        text: Google Sans
        code: Regular
    features:
        - navigation.instant
        - navigation.tracking
        - navigation.top
        - search.highlight
        - search.share
    extra_css:
    - overrides/assets.css

plugins:
    - search
    - mkdocstrings:
        handlers:
            python:
                docstring_style: google
                options:
                    show_root_heading: true
    - git-revision-date
    - git-revision-date-localized:
          enable_creation_date: true
          type: timeago
    - mkdocs-jupyter:
          include_source: true
          ignore_h1_titles: true
          execute: false
          allow_errors: false
          ignore: ["conf.py"]
          execute_ignore: ["*ignore.ipynb"]

markdown_extensions:
    - admonition
    - abbr
    - attr_list
    - def_list
    - footnotes
    - meta
    - md_in_html
    - tables
    - pymdownx.details
    - pymdownx.superfences
    - pymdownx.tabbed:
          alternate_style: true
    - pymdownx.highlight:
          linenums: true
    - toc:
          permalink: true

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - Datasets:
        - Overview: datasets.md
        - MSWX Guide: MSWX_guide.md
        - DWD Export Format: dwd_format_guide.md
    - Bias Correction: bcsd_guide.md
    - Examples:
        - Workflow Tutorial: examples/wrapper_workflow.ipynb
        - Datasets:
            - MSWX: examples/datasets/mswx_example.ipynb
            - CMIP6 bias-adjusted (0.5 deg): examples/datasets/cmip_w5e5_example.ipynb
        - Grids:
            - Resolution & Projection Transformation: examples/grid/reprojection.ipynb
        - Advanced:
            - Multi-Dataset Comparison: examples/datasets/multi_dataset_comparison.ipynb
            - CMIP vs Observations: examples/advanced/cmip_obs_comparison.ipynb
            - Bias Correction & Downscaling: examples/sdba/sdba.ipynb
    - Reference:
        - API: api.md
        - Concepts: common.md
        - FAQ: faq.md
    - Contributing: contributing.md
    - Changelog: changelog.md
    - Report Issues: https://github.com/Kaushikreddym/climdata/issues