aigroup/mkdocs.yml at main · E3SM-Project/aigroup · 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
130
131
132
133
site_name: AI Group
site_description: E3SM AI Group
site_url: https://e3sm-project.github.io/aigroup
repo_name: aigroup
edit_uri: edit/main/docs

theme:
  name: material
  features:
    # Navigation
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.tracking
    - navigation.instant
    - navigation.instant.progress
    - navigation.footer
    - navigation.top
    - toc.follow
    # Search
    - search.suggest
    - search.highlight
    - search.share
    # Content
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.action.edit
    - content.action.view
    - content.tabs.link
    - content.tooltips
    # Header
    - header.autohide
    - announce.dismiss
  palette:
    # Light Mode - E3SM Ocean Blue & Earth Green
    - scheme: default
      primary: indigo
      accent: green
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark Mode - E3SM Ocean Blue & Earth Green
    - scheme: slate
      primary: indigo
      accent: green
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/images/E3SM_Icon_270.png
  logo: assets/images/E3SM_Logo.png
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - social:
      cards_layout_options:
        logo: docs/assets/images/E3SM_Icon_270.png

repo_url: https://github.com/E3SM-Project/aigroup
repo_name: E3SM-Project/aigroup

extra_css:
  - assets/stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/E3SM-Project
      name: E3SM Project on GitHub
  generator: false

markdown_extensions:
  # Admonitions
  - admonition
  - pymdownx.details
  # Code
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # Formatting
  - pymdownx.critic:
      mode: accept
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  # Tabs & Tasks
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  # Emoji & Icons
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # HTML & Attributes
  - attr_list
  - md_in_html
  - def_list
  # Tables & Footnotes
  - tables
  - footnotes
  # Math
  - pymdownx.arithmatex:
      generic: true

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

nav:
  - Home: index.md
  - Quick Guides:
      - Python Environment Setup: python-envs.md
      - ACE2-ERA5 Training: ace2-workflow.md
      - ACE2-ERA5 Training (Spatial Decomposition): ace2-spatial-decomp.md
      - SCREAM v1 Example: screamv1-example.md
      - ACE2-EAMv3 Inference: ace2-inference.md
      - E3SM branch runs: e3sm-branch-runs.md