etos/mkdocs.yml at main · eiffel-community/etos · 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
# Copyright Axis Communications AB
# For a full list of individual contributors, please see the commit history.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
site_name: ETOS
site_url: https://etos.readthedocs.io
site_description: ETOS is a test orchestration framework for testing complex systems

repo_url: https://github.com/eiffel-community/etos

nav:
  - Home: index.md
  - Core concepts: "core_concept.md"
  - Installation:
    - Installation: ./installation/index.md
    - Local installation: ./installation/local.md
    - Production concerns: ./installation/production.md
    - Upgrade: ./installation/upgrade.md
    - Uninstall: ./installation/uninstall.md
  - Guides:
    - Getting started: ./getting_started/index.md
    - Using the API: ./getting_started/api.md
    - Create TestRun resources in Kubernetes: ./getting_started/testrun.md
    - Roles:
      - System engineer: ./roles/system_engineer.md
      - Test automation engineer: ./roles/test_automation_engineer.md
      - Test engineer: ./roles/test_engineer.md
    - Creating a provider: ./getting_started/providers.md
  - Authors: ./AUTHORS.md
  - License: ./LICENSE.txt
  - Contributing: https://github.com/eiffel-community/.github/blob/master/CONTRIBUTING.md
  - Code of Conduct: https://github.com/eiffel-community/.github/blob/master/CODE_OF_CONDUCT.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

theme:
  name: material  # TODO: Add to requirements
  theme:
  features:
    - content.code.copy
    - content.code.select
  palette:
  # Palette toggle for automatic mode
  - media: "(prefers-color-scheme)"
    scheme: default
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode

  # Palette toggle for light mode
  - media: "(prefers-color-scheme: light)"
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode

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