syclops/docs/mkdocs.yml at main · DFKI-NI/syclops · 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
site_name: Syclops Documentation
site_description: Documentation for the Syclops synthetic data generation tool
site_author: Anton Elmiger
site_url: https://dfki-ni.github.io/syclops/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.path
    - navigation.tabs
    - navigation.top
    - search.suggest
    # - toc.integrate
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.code.select
  language: en
  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
      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
      accent: red
  logo: img/logo.png
  favicon: img/favicon.ico
markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Usage:
    - Command Line: usage/command_line.md
    - Job Description:
      - Job Configuration: usage/job_description/job_configuration.md
      - Validation: usage/job_description/validation.md
      - Dynamic Evaluators: usage/job_description/dynamic_evaluators.md
    - Plugin Configuration:
      - Ground: usage/job_description/config_descriptions/ground.md
      - Environment: usage/job_description/config_descriptions/environment.md
      - Object: usage/job_description/config_descriptions/object.md
      - Scatter: usage/job_description/config_descriptions/scatter.md
      - Crop: usage/job_description/config_descriptions/crop.md
      - Simulated Scatter: usage/job_description/config_descriptions/simulated_scatter.md
    - Sensor Configuration:
      - Camera: usage/job_description/config_descriptions/camera.md
    - Output Configuration:
      - RGB: usage/job_description/config_descriptions/rgb.md
      - Pixel Annotation: usage/job_description/config_descriptions/pixel_annotation.md
      - Object Position: usage/job_description/config_descriptions/object_position.md
      - Keypoint Annotation: usage/job_description/config_descriptions/keypoint_annotation.md
      - Structured Light: usage/job_description/config_descriptions/structured_light.md
    - Post Processing:
      - Bounding Boxes: usage/job_description/config_descriptions/bounding_box.md
    - Assets: usage/assets/assets.md
    - FAQ: usage/faq.md
  - Developement:
    - Architecture: developement/architecture.md
    - Add Functionality:
      - Create Scene Plugin: developement/add_functionality/create_plugin.md
      - Create Sensor and Output Plugin: developement/add_functionality/create_sensor.md
    - Debugging: developement/debugging.md

extra_css:
  - stylesheets/extra.css
plugins:
  - glightbox:
      auto_caption: true
  - search