CRAB/mkdocs.yml at master · HLC-Lab/CRAB · 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
site_name: CRAB
site_description: Co-Running Applications Benchmarking framework
site_url: https://hlc-crab.readthedocs.io/
repo_url: https://github.com/HLC-Lab/CRAB
repo_name: HLC-Lab/CRAB
edit_uri: edit/master/docs/

theme:
  name: material
  logo: assets/svg/favicon-dark.svg
  favicon: assets/svg/favicon-cream.svg
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - content.action.edit
    - toc.follow
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep orange
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

# Pages are added to the nav as they are written.
nav:
  - Home: index.md
  - Concepts:
      - System-dependent vs system-independent: concepts/system-dependent-vs-independent.md
      - Architecture: concepts/architecture.md
  - Tutorial: tutorial.md
  - Using CRAB:
      - Installation & benchmark setup: using/installation.md
      - Configuring your cluster: using/presets.md
      - Running an experiment: using/running.md
      - Writing experiment configs: using/writing-configs.md
      - Reading results: using/results.md
  - Extending CRAB:
      - Overview: extending/overview.md
      - Writing a wrapper: extending/wrappers.md
      - Adding a build recipe: extending/recipes.md
      - From recipe to receipt: extending/receipts.md
  - Reference:
      - CLI commands: reference/cli.md
      - Configuration schema: reference/configuration.md
      - presets.json format: reference/presets.md
      - Supported benchmarks: reference/supported-benchmarks.md
      - Wrapper & Recipe API: reference/api.md
  - Contributing: contributing.md
  - Glossary: glossary.md