run-orchestrator/mkdocs.yml at main · Cosmo-Tech/run-orchestrator · 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
134
site_name: Run Template Orchestrator
repo_url: https://github.com/Cosmo-Tech/run-orchestrator
repo_name: Cosmo-Tech/run-orchestrator
site_description: Cosmo Tech ORC helps with defining and running commands DAG
site_url: https://cosmo-tech.github.io/run-orchestrator/
theme:
  name: material
  logo: assets/logo.png
  font:
    code: Fira Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.instant
    - navigation.footer
    - navigation.sections
  custom_dir: overrides
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css
  - stylesheets/templates.css

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascript/tablesort.js

extra:
  version:
    provider: mike

nav:
  - Home:
    - Cosmo Tech Run Orchestrator: 'index.md'
    - License: 'License.md'
    - Dependencies: 'dependencies.md'
  - Tutorials:
      - "tutorial/index.md"
      - "tutorial/getting_started.md"
      - "tutorial/configuration_and_environment.md"
      - "tutorial/cosmotech_simulator.md"
      - "tutorial/advanced_cosmotech_simulator.md"
      - "tutorial/plugins_and_templates.md"
      - "tutorial/exit_handlers.md"
      - "tutorial/translations.md"
      - "tutorial/step_data_transfer.md"
  - Examples:
      - "examples/index.md"
      - "examples/simple_simulation_run.md"
      - "examples/simple_script_run.md"
      - "examples/legacy_run.md"
      - "examples/git_run.md"
      - "examples/minimal_docker.md"
  - Semantic Validator: "Validator.md"
  - Commands:
      - Orchestrator:
        - "commands/orchestrator.md"
        - "commands/list_templates.md"

markdown_extensions:
    - admonition
    - attr_list
    - footnotes
    - md_in_html
    - tables
    - toc:
        title: "In this page"
        permalink: true
    - def_list
    - pymdownx.details
    - pymdownx.snippets:
        url_download: true
    - pymdownx.betterem
    - pymdownx.superfences
    - pymdownx.highlight
    - pymdownx.inlinehilite
    - pymdownx.critic
    - pymdownx.caret
    - pymdownx.keys
    - pymdownx.mark
    - pymdownx.tilde
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
    - search:
        lang:
          - en
    - mkdocstrings:
        default_handler: python
        handlers:
          python:
            options:
              docstring_style: sphinx
              line_length: 120
    - gen-files:
        scripts:
          - scripts/generate_index.py
          - scripts/generate_helps.py
          - scripts/generate_requirements.py
    - literate-nav
    - autorefs:
        link_titles: false
    - mike
    - social
    - include_dir_to_nav

watch:
  - examples
  - partials
  - tutorial