firecrest-v2/mkdocs.yml at master · eth-cscs/firecrest-v2 · 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
site_name: FirecREST v2 Documentation

# provide a link to the docs in top RHS corner
repo_url: https://github.com/eth-cscs/firecrest-v2/
# provide a link to "edit this page" to each page
edit_uri: edit/master/docs/

nav:
  - Welcome: README.md
  - 'Getting started':
    - getting_started/README.md
  - Setup:
    - 'Architecture':
      - setup/arch/README.md
      - 'Systems':
        - setup/arch/systems/README.md
      - 'Authentication and authorization':
        - setup/arch/auth/README.md
      - 'Data transfer':
        - setup/arch/external_storage/README.md
      - 'Health checks':
        - setup/arch/health_checks/README.md
      - 'Logging':
        - setup/arch/logging/README.md
    - 'Configuration':
      - setup/conf/README.md
    - 'Install':
      - setup/install/README.md
  - 'User guide':
    - user_guide/README.md
  - 'Use cases':
    - use_cases/README.md
    - 'CI pipelines':
      - use_cases/CI-pipeline/README.md
    - 'Workflow orchestrator':
      - use_cases/workflow-orchestrator/README.md
    - 'JupyterHub':
      - use_cases/jupyterhub/README.md
    - 'Web UI Application':
      - use_cases/UI-client-credentials/README.md
  - 'API Reference': https://eth-cscs.github.io/firecrest-v2/openapi/

theme:
  name: material
  language: en
  features:
    - content.code.copy
    # add an "edit this page" icon on each page
    - content.action.edit
    - navigation.indexes
    - search.share
    - navigation.instant
    - navigation.tracking
    - navigation.path
    - navigation.top
  icon:
    # set the icon for "edit this page"
    edit: material/pencil
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: white
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  logo: assets/img/firecrest-logo.gif
  favicon: assets/img/favicon.ico
  font:
    text: Roboto
    code: Roboto Mono

plugins:
  - search:
      pipeline:
        - trimmer
  - autorefs

markdown_extensions:
  - admonition
  - def_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  # for captioning images
  - pymdownx.blocks.caption

extra_css:
  - stylesheets/extra.css