commonroad-control/mkdocs.yml at develop · CommonRoad/commonroad-control · 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
site_name: CommonRoad Control

theme:
  name: material
  logo: assets/commonroad_white150.png

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
            show_root_heading: true
            heading_level: 3
  - search

markdown_extensions:
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg

  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Introduction:
    - "Introduction": index.md
    - "Concept": introduction/concept.md
    - "Architecture": introduction/classdiagram.md

  - Examples:
      - "Minimal examples": examples/minimal_examples.md
      - "Long example - PID": examples/long_example_pid.md
      - "Long example - MPC": examples/long_example_mpc.md
      - "Visualization": examples/visualization_example.md
      - "Closing the Planning+Control Loop": examples/closing_pc_loop.md

  - Explanations:
      - "Introduction": explanations/expl_introduction.md

      - "Control":
          - "PID Controller": explanations/control/pid.md
          - "Model Predictive Control": explanations/control/mpc.md
          - "Reference Trajectory Factory": explanations/control/ref_traj.md

      - "Simulation":
          - "Simulation": explanations/simulation/simulation.md
          - "Sensor Models": explanations/simulation/sensor_models.md
          - "Uncertainty Models": explanations/simulation/uncertainty_models.md

      - "Vehicle Dynamics":
          - "Interfaces": explanations/vehicle_dynamics/interfaces.md
          - "Kinematic Bicycle": explanations/vehicle_dynamics/kb.md
          - "Dynamic Bicycle": explanations/vehicle_dynamics/db.md
          - "Double Integrator": explanations/vehicle_dynamics/di.md

  - Integrating your own work:
    - "Planner Integration": integrate_your_own_work/planner_integration.md
    - "Controller Integration": integrate_your_own_work/controller_integration.md
    - "Vehicle Dynamics Model Integration": integrate_your_own_work/dynamics_integration.md

  - Easy API:
      - "PID": easy_api/easy_pid.md
      - "MPC": easy_api/easy_mpc.md

  - Core API:
      - "Control":
          - "Controller Interface": core_api/control/controller_interface.md
          - "Model Predictive Control": core_api/control/mpc.md
          - "PID": core_api/control/pid.md
          - "Reference Trajectory": core_api/control/ref_traj.md

      - "Simulation":
          - "Simulation": core_api/simulation/simulation.md
          - "Sensor Models": core_api/simulation/sensor_models.md
          - "Uncertainty Models": core_api/simulation/uncertainty_models.md

      - "Vehicle Dynamics":
          - "Interfaces": core_api/vehicle_dynamics/interfaces.md
          - "Kinematic Bicycle": core_api/vehicle_dynamics/kb.md
          - "Dynamic Bicycle": core_api/vehicle_dynamics/db.md
          - "Double Integrator": core_api/vehicle_dynamics/di.md

      - "Vehicle Parameters":
          - "Interface": core_api/vehicle_parameters/interfaces.md
          - "BMW 3": core_api/vehicle_parameters/bmw3.md

      - "Planning Converter":
          - "Interface": core_api/planning_converter/interfaces.md
          - "Reactive Planner Converter": core_api/planning_converter/reactive_planner_converter.md

      - "utils":
          - "visualization": core_api/util/visualization.md
          - "other utils": core_api/util/other_util.md