Skip to content

Commit cd8d3a9

Browse files
committed
Set structure to doc index
1 parent 5fcda3d commit cd8d3a9

File tree

2 files changed

+58
-17
lines changed

2 files changed

+58
-17
lines changed

.github/workflows/test_windows.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ jobs:
2020

2121
- name: Build SimLibs
2222
shell: cmd
23-
run: build simlibs_debug
23+
run: build simlibs_debug

docs/source/index.md

Lines changed: 57 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,94 @@
1+
# Project AirSim
2+
13
```{include} ../../README.md
24
:relative-docs: docs_build/source
35
:relative-images: docs_build/source/images
46
```
57

8+
```{toctree}
9+
:maxdepth: 2
10+
:caption: Introduction
11+
12+
README.md
13+
```
14+
615
```{toctree}
716
:maxdepth: 2
817
:caption: Getting Started
18+
919
internal/use_source.md
1020
internal/use_prebuilt.md
1121
internal/dev_setup_linux.md
1222
internal/dev_setup_win.md
13-
internal/headless_cloud.md
1423
internal/vscode_user_settings.md
15-
---
24+
internal/headless_cloud.md
25+
```
26+
27+
```{toctree}
1628
:maxdepth: 2
1729
:caption: ROS Integration
30+
1831
ros/ros.md
1932
ros/ros2.md
2033
ros/ros_examples.md
2134
ros/example_build_map.md
2235
ros/example_navigate_map.md
23-
---
36+
```
37+
38+
```{toctree}
2439
:maxdepth: 2
2540
:caption: Sensors
26-
sensors/battery.md
27-
sensors/lidar.md
28-
sensors/radar.md
29-
sensors/segmentation.md
41+
3042
sensors/camera_capture_settings.md
3143
sensors/camera_post_processing_with_nn.md
3244
sensors/camera_streaming.md
33-
---
45+
sensors/segmentation.md
46+
sensors/lidar.md
47+
sensors/radar.md
48+
sensors/battery.md
49+
internal/sensors/display.md
50+
```
51+
52+
```{toctree}
3453
:maxdepth: 2
3554
:caption: Data Collection
55+
3656
datacollection/config.md
37-
datacollection/data_aggregation.md
38-
datacollection/data_generation.md
3957
datacollection/randomizations.md
4058
datacollection/trajectory.md
41-
---
59+
datacollection/data_generation.md
60+
datacollection/data_aggregation.md
61+
```
62+
63+
```{toctree}
4264
:maxdepth: 2
43-
:caption: Physics
65+
:caption: Physics and Simulation
66+
4467
physics/fast_physics.md
4568
physics/matlab_physics.md
4669
internal/physics/unreal_physics.md
47-
---
48-
:maxdepth: 2
49-
:caption: Scene and Simulation
5070
scene/sim_clock.md
5171
scene/weather_visual_effects.md
5272
internal/scene/sim_clock_internal.md
53-
internal/sensors/display.md
73+
```
74+
75+
```{toctree}
76+
:maxdepth: 2
77+
:caption: Code Structure
78+
79+
code_structure.md
80+
```
81+
82+
```{toctree}
83+
:maxdepth: 2
84+
:caption: APIs and Programmatic Control
85+
86+
apis.md
87+
```
88+
89+
```{toctree}
90+
:maxdepth: 2
91+
:caption: Settings
92+
93+
settings.md
94+
```

0 commit comments

Comments
 (0)