cloud-azimuth-user-docs/mkdocs.yml at main · jcornall/cloud-azimuth-user-docs · 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
site_name: STFC Azimuth Science Platform
repo_url: https://github.com/stfc/cloud-azimuth-user-docs
copyright: |
  Copyright &copy; 2025 Science and Technology Facilities Council</br>
  Licensed under the Apache License, Version 2.0.
edit_uri: ''
nav:
  - 'Introduction': 'index.md'
  - 'Platforms':
    - 'Kubernetes':
      - 'Overview': 'platforms/kubernetes.md'
      - 'Kubernetes Applications':
        - 'JupyterHub': 'platforms/kubernetes-applications/jupyterhub.md'
          # - 'Deploying JupyterHub': 'platforms/kubernetes-applications/jupyterhub.md'
        - 'DaskHub': 'platforms/kubernetes-applications/daskhub.md'
          # - 'Deploying DaskHub': 'platforms/kubernetes-applications/daskhub.md'
        - 'ArgoCD': 'platforms/kubernetes-applications/argocd.md'
          # - 'Deploying ArgoCD': 'platforms/kubernetes-applications/argocd.md'
        - 'BinderHub': 'platforms/kubernetes-applications/binderhub.md'
          # - 'Deploying Binderhub': 'platforms/kubernetes-applications/binderhub.md'
        - 'KubeFlow': 'platforms/kubernetes-applications/kubeflow.md'
          # - 'Deploying KubeFlow': 'platforms/kubernetes-applications/kubeflow.md'
        - 'HuggingFace LLM': 'platforms/kubernetes-applications/huggingface-llm.md'
          # - 'Deploying HuggingFace LLM': 'platforms/kubernetes-applications/huggingface-llm.md'
    # - 'Linux Workstation': 'platforms/linux-workstation.md'
    # - 'Jupyter Notebook': 'platforms/jupyter-notebook.md'
    # - 'Slurm': 'platforms/slurm.md'
  - 'Identity Provider': 'identity_provider/identity_provider.md'
  - 'Quotas': 'quotas/quotas.md'
  - 'Advanced':
    - 'Machines': 'advanced/machines.md'
    - 'Volumes': 'advanced/volumes.md'

theme:
  features:
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
  name: material
  custom_dir: docs/assets/overrides
  logo: assets/images/Cloud-Logo-Square.png
  favicon: assets/images/UKRI_STFC_Square_RGB.png
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: custom
      accent: custom

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

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - docs/assets/overrides/.icons
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - sane_lists
  - footnotes

plugins:
  - git-revision-date-localized:
      enable_creation_date: true
  - glightbox