commonroad-sumo-interface/mkdocs.yml at github · CommonRoad/commonroad-sumo-interface · 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
site_name: CommonRoad SUMO Interface
nav:
  - index.md
  - Usage:
    - usage/interactive_simulation.md
  - Advanced:
    - advanced/sync.md
    - advanced/logging.md
    - advanced/simulation_backends.md
  - Reference:
    - reference/index.md
  - development.md
theme:
  name: material
  logo: img/commonroad_white150.png
  features:
  - content.code.copy
  - content.code.annotate
  # Dark/Light Theme switching and auto-detection.
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: indigo
    accent: blue
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: indigo
    accent: blue
    toggle:
      icon: material/weather-night
      name: Switch to system preference
plugins:
- autorefs
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        paths: [commonroad_sumo]
        inventories:
          - https://docs.python.org/3/objects.inv
          - https://cps.pages.gitlab.lrz.de/commonroad/commonroad-io/objects.inv
        options:
          # By default the CommonRoad projects use sphinx for documentation.
          docstring_style: "sphinx"
          # Include all python elements even if they have no docstring.
          show_if_no_docstring: true
          heading_level: 3
          # Indicates which module the section is about.
          show_root_toc_entry: true
          show_root_heading: true
          # Merge the documentation of a class with the documentation of its init.
          # Ensures consistency for different documentation styles.
          merge_init_into_class: true
          # The signature of an attribute/method is split into two lines: one with the name as heading and one with the signature.
          # This greatly increases the readability of the documentation.
          separate_signature: true
          # Do not show a button to reveal the source.
          show_source: false
          # Include the signatures (i.e. typing information) for each element.
          show_signature_annotations: true
          # Show what type an element has (i.e. attr, class, meth) in its heading.
          show_symbol_type_heading: true
          # Show what type an element has (i.e. attr, class, meth) in the Table of Contents.
          show_symbol_type_toc: true
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences:
    custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format