-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
233 lines (222 loc) · 8.91 KB
/
mkdocs.yml
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
#
# mkdocs.yml
#
# MkDocs configuration file.
#
# Copyright 2024 Nervosys, LLC
#
site_name: "AutonomySim"
site_description: "The simulation engine for autonomous systems"
site_url: "https://github.com/nervosys/AutonomySim"
site_dir: "build_docs"
repo_name: "nervosys/AutonomySim"
repo_url: "https://github.com/nervosys/AutonomySim"
remote_branch: "gh-pages"
remote_name: "origin"
edit_uri: "edit/master/docs/"
copyright: "Copyright © 2024 <a href=https://nervosys.ai/>Nervosys, LLC</a>"
theme:
name: material # options: readthedocs mkdocs material
features:
- announce.dismiss
- content.code.annotate
- content.code.copy
- content.tabs.link
# - header.autohide
# - mkdocstrings
# - navigation.expand
# - navigation.instant
- navigation.top
# - navigation.tabs
# - navigation.sections
# - navigation.instant
- navigation.path
- navigation.footer
# - navigation.tracking
# - search.highlight
- search.suggest
- search.share
- toc.follow
- toc.integrate
font:
text: "Roboto"
code: "Roboto Mono"
language: en
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: "Switch to light mode"
- media: "(prefers-color-scheme: light)"
scheme: nervosys_light
toggle:
icon: material/brightness-7
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: nervosys_dark
toggle:
icon: material/brightness-4
name: "Switch to system preference"
favicon: media/images/rune.svg
icon:
logo: material/book-open-page-variant
repo: fontawesome/brands/git-alt
edit: material/pencil
view: material/eye
plugins:
- search
- offline
#- social
#- optimize
markdown_extensions:
- admonition
- toc:
permalink: "#"
- attr_list
- md_in_html
- pymdownx.highlight:
use_pygments: true
# pygments_style: default
pygments_lang_class: true
anchor_linenums: true
line_spans: __span
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.arithmatex:
generic: true
extra_css:
- css/extra.css
# - "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/styles/default.min.css" # highlight.js
extra_javascript:
- js/extra.js
- js/mathjax.js
- "https://polyfill.io/v3/polyfill.min.js?features=es6"
- "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
# - "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js" # highlight.js
extra:
highlightjs: true
version:
default: latest
feature:
tabs: true
analytics:
provider: google
property: "G-QQF2PS4P1M"
social:
- icon: fontawesome/brands/github-alt
link: "https://github.com/nervosys/AutonomySim"
- icon: fontawesome/brands/discord
link: "https://discord.gg/x84JXYje"
- icon: fontawesome/brands/x-twitter
link: "https://x.com/nervosys"
generator: false
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
nav:
- index.md # generated with MkDocs
- CHANGELOG.md
- "API Documentation":
- "Python API": api/python/html/index.html # generated with Sphinx
- "C++ API": api/cpp/html/index.html # generated with Doxygen, Breathe, Sphinx
- "Building AutonomySim":
- project_binaries.md
- build_windows.md
- build_linux.md
- build_macos.md
- docker_ubuntu.md
- azure.md
- unreal_envs.md
- build_faq.md
- "Using AutonomySim":
- apis.md
- apis_image.md
- apis_cpp.md
- development_workflow.md
- settings.md
- camera_views.md
- using_car.md
- controller_robot.md
- controller_remote.md
- controller_wired.md
- controlller_wheel.md
- multivehicle.md
- "Sensors":
- sensors.md
- lidar.md
- distance_sensor.md
- InfraredCamera.md
- "ROS":
- ros_pkgs.md
- ros_pkgs_tutorial.md
- gazebo_drone.md
- retexturing.md
- meshes.md
- playback.md
- voxel_grid.md
- event_sim.md
- "Design":
- design.md
- project_structure.md
- apis_new.md
- Modifying Recordin data_capture.md
- coding_guidelines.md
- robot_controller.md
- simple_flight.md
- hello_drone.md
- "Flight Controllers":
- "Pixhawk/PX4":
- px4_setup.md
- px4_sitl.md
- px4_sitl_wsl2.md
- px4_lockstep.md
- px4_multivehicle.md
- "AutonomySim with Pixhawk": "https://youtu.be/1oY8Qu5maQQ"
- "PX4 Setup with AutonomySim": "https://youtu.be/HNWdYrtw3f0"
- "Debugging Attitude Estimation": "https://www.youtube.com/watch?v=d_FyjKDWQfc&feature=youtu.be"
- "Intercepting MavLink Messages": "https://github.com/nervosys/AutonomySim/wiki/Intercepting-MavLink-messages"
- "Rapid Descent on PX4 Drones": "https://github.com/nervosys/AutonomySim/wiki/Rapid-Descent-on-PX4-drones"
- px4_build.md
- px4_logging.md
- mavlink_logviewer.md
- mavlink_playback.md
- mavlink_comm.md
- mavlink_mocap.md
- "APM/ArduPilot":
- "ArduPilot SITL Setup": "https://ardupilot.org/dev/docs/building-the-code.html"
- "AutonomySim & ArduPilot": "https://ardupilot.org/dev/docs/sitl-with-AirSim.html"
- "Upgrading":
- unreal_upgrading.md
- apis_upgrading.md
- settings_upgrading.md
- "Community Tutorials":
- reinforcement_learning.md
- "Using Environments from Marketplace": "https://www.youtube.com/watch?v=y09VbdQWvQY"
- "Simple Collision Avoidance": "https://github.com/simondlevy/AirSimTensorFlow"
- "Autonomous Driving on Azure": "https://aka.ms/AutonomousDrivingCookbook"
- "Building Hexacopter": "https://github.com/nervosys/AutonomySim/wiki/hexacopter"
- "Moving on Path Demo": "https://github.com/nervosys/AutonomySim/wiki/moveOnPath-demo"
#- Building Point Clouds: point_clouds.md
- surveying.md
- orbit.md
- "Importing a custom multirotor mesh": "https://youtu.be/Bp86WiLUC80"
- object_detection.md
- "AutonomySim with MAVROS and PX4": "https://youtu.be/ZonkdMcwXH4"
- "Other":
- real_vhicles.md
- cmake_linux.md
- performance_hardware.md
- format_pfm.md
- unreal_projects.md
- unreal_blocks.md
- unreal_plugins.md
- "Formula Student Technion Self-driving Car": "https://github.com/nervosys/AutonomySim/wiki/technion"
- userbase.md
- "Support":
- faq.md
- SUPPORT.md
- create_issues.md
- CONTRIBUTING.md