generated from tier4/ros2-project-template
-
Notifications
You must be signed in to change notification settings - Fork 51
/
mkdocs.yml
224 lines (216 loc) · 9.07 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
### Site metadata ###
site_name: Nebula
site_description: Nebula Multi-Sensor Driver Framework
repo_url: https://github.com/tier4/nebula
docs_dir: docs
copyright: Copyright © 2023 TIER IV, Inc.
### Theme settings ###
theme:
name: material
language: en
# logo: docs/logo.png
# favicon: docs/favicon.png
features:
- navigation.tabs
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
palette:
- scheme: default
primary: white
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
primary: grey
toggle:
icon: material/weather-night
name: Switch to light mode
use_directory_urls: true
### Navigation ###
nav:
- Home: index.md
- Supported sensors: supported_sensors.md
- Installation: installation.md
- Usage: usage.md
- Parameters:
- parameters.md
- Hesai:
- parameters/vendors/hesai/common.md
- Pandar40P: parameters/vendors/hesai/pandar40p.md
- Pandar64: parameters/vendors/hesai/pandar64.md
- OT128: parameters/vendors/hesai/ot128.md
- QT64: parameters/vendors/hesai/qt64.md
- QT128: parameters/vendors/hesai/qt128.md
- AT128: parameters/vendors/hesai/at128.md
- XT32: parameters/vendors/hesai/xt32.md
- XT32M: parameters/vendors/hesai/xt32m.md
- Velodyne:
- parameters/vendors/velodyne/common.md
- VLP16: parameters/vendors/velodyne/vlp16.md
- VLP32: parameters/vendors/velodyne/vlp32.md
- VLS128: parameters/vendors/velodyne/vls128.md
- Robosense:
- parameters/vendors/robosense/common.md
- BPearl: parameters/vendors/robosense/bpearl.md
- Helios: parameters/vendors/robosense/helios.md
- Continental:
- parameters/vendors/continental/common.md
- ARS548: parameters/vendors/continental/ars548.md
- SRR520: parameters/vendors/continental/srr520.md
- Point cloud types: point_types.md
- Design: design.md
- Tutorials: tutorials.md
- Contributing: contribute.md
- API reference:
- api_reference.md
- Nebula common:
- Links: nebula_common/links.md
- Classes:
- Class List: nebula_common/annotated.md
- Class Index: nebula_common/classes.md
- Class Hierarchy: nebula_common/hierarchy.md
- Class Members: nebula_common/class_members.md
- Class Member Functions: nebula_common/class_member_functions.md
- Class Member Variables: nebula_common/class_member_variables.md
- Class Member Typedefs: nebula_common/class_member_typedefs.md
- Class Member Enumerations: nebula_common/class_member_enums.md
- Namespaces:
- Namespace List: nebula_common/namespaces.md
- Namespace Members: nebula_common/namespace_members.md
- Namespace Member Functions: nebula_common/namespace_member_functions.md
- Namespace Member Variables: nebula_common/namespace_member_variables.md
- Namespace Member Typedefs: nebula_common/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_common/namespace_member_enums.md
- Functions: nebula_common/functions.md
- Variables: nebula_common/variables.md
- Macros: nebula_common/macros.md
- Files: nebula_common/files.md
- Nebula decoders:
- Links: nebula_decoders/links.md
- Classes:
- Class List: nebula_decoders/annotated.md
- Class Index: nebula_decoders/classes.md
- Class Hierarchy: nebula_decoders/hierarchy.md
- Class Members: nebula_decoders/class_members.md
- Class Member Functions: nebula_decoders/class_member_functions.md
- Class Member Variables: nebula_decoders/class_member_variables.md
- Class Member Typedefs: nebula_decoders/class_member_typedefs.md
- Class Member Enumerations: nebula_decoders/class_member_enums.md
- Namespaces:
- Namespace List: nebula_decoders/namespaces.md
- Namespace Members: nebula_decoders/namespace_members.md
- Namespace Member Functions: nebula_decoders/namespace_member_functions.md
- Namespace Member Variables: nebula_decoders/namespace_member_variables.md
- Namespace Member Typedefs: nebula_decoders/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_decoders/namespace_member_enums.md
- Functions: nebula_decoders/functions.md
- Variables: nebula_decoders/variables.md
- Macros: nebula_decoders/macros.md
- Files: nebula_decoders/files.md
- Nebula HW interfaces:
- Links: nebula_hw_interfaces/links.md
- Classes:
- Class List: nebula_hw_interfaces/annotated.md
- Class Index: nebula_hw_interfaces/classes.md
- Class Hierarchy: nebula_hw_interfaces/hierarchy.md
- Class Members: nebula_hw_interfaces/class_members.md
- Class Member Functions: nebula_hw_interfaces/class_member_functions.md
- Class Member Variables: nebula_hw_interfaces/class_member_variables.md
- Class Member Typedefs: nebula_hw_interfaces/class_member_typedefs.md
- Class Member Enumerations: nebula_hw_interfaces/class_member_enums.md
- Namespaces:
- Namespace List: nebula_hw_interfaces/namespaces.md
- Namespace Members: nebula_hw_interfaces/namespace_members.md
- Namespace Member Functions: nebula_hw_interfaces/namespace_member_functions.md
- Namespace Member Variables: nebula_hw_interfaces/namespace_member_variables.md
- Namespace Member Typedefs: nebula_hw_interfaces/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_hw_interfaces/namespace_member_enums.md
- Functions: nebula_hw_interfaces/functions.md
- Variables: nebula_hw_interfaces/variables.md
- Macros: nebula_hw_interfaces/macros.md
- Files: nebula_hw_interfaces/files.md
- Nebula ROS:
- Links: nebula_ros/links.md
- Classes:
- Class List: nebula_ros/annotated.md
- Class Index: nebula_ros/classes.md
- Class Hierarchy: nebula_ros/hierarchy.md
- Class Members: nebula_ros/class_members.md
- Class Member Functions: nebula_ros/class_member_functions.md
- Class Member Variables: nebula_ros/class_member_variables.md
- Class Member Typedefs: nebula_ros/class_member_typedefs.md
- Class Member Enumerations: nebula_ros/class_member_enums.md
- Namespaces:
- Namespace List: nebula_ros/namespaces.md
- Namespace Members: nebula_ros/namespace_members.md
- Namespace Member Functions: nebula_ros/namespace_member_functions.md
- Namespace Member Variables: nebula_ros/namespace_member_variables.md
- Namespace Member Typedefs: nebula_ros/namespace_member_typedefs.md
- Namespace Member Enumerations: nebula_ros/namespace_member_enums.md
- Functions: nebula_ros/functions.md
- Variables: nebula_ros/variables.md
- Macros: nebula_ros/macros.md
- Files: nebula_ros/files.md
### Extra Settings ###
plugins:
- macros:
module_name: mkdocs_macros
render_by_default: false
force_render_paths: |
*
!*_source.md
- mkdoxy:
projects:
nebula_common:
src-dirs: nebula_common/include
full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.hpp *.h"
RECURSIVE: true
EXTRACT_ALL: true
INLINE_SOURCES: true
ENABLE_PREPROCESSING: true
MACRO_EXPANSION: true
nebula_decoders:
src-dirs: nebula_decoders/include
full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.hpp *.h"
RECURSIVE: true
EXTRACT_ALL: true
INLINE_SOURCES: true
ENABLE_PREPROCESSING: true
MACRO_EXPANSION: true
nebula_hw_interfaces:
src-dirs: nebula_hw_interfaces/include
full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.hpp *.h"
RECURSIVE: true
EXTRACT_ALL: true
INLINE_SOURCES: true
ENABLE_PREPROCESSING: true
MACRO_EXPANSION: true
nebula_ros:
src-dirs: nebula_ros/include
full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.hpp *.h"
RECURSIVE: true
EXTRACT_ALL: true
INLINE_SOURCES: true
ENABLE_PREPROCESSING: true
MACRO_EXPANSION: true
save-api: .mkdoxy
full-doc: true
debug: false
ignore-errors: false
- search:
lang: en
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight
- pymdownx.superfences