-
Notifications
You must be signed in to change notification settings - Fork 11
/
mkdocs.yml
83 lines (72 loc) · 3.31 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
# mkdocs.yml
site_name: Arena Rosnav
nav:
- Introduction: "index.md"
- Publications: "publications.md"
- Contribute: "contribute.md"
- User Guides:
- Installation: "user_guides/installation.md"
- Models: "user_guides/models.md"
- Task Modes: "user_guides/task_modes.md"
- Planners: "user_guides/planners_overview.md"
- Usage: "user_guides/usage.md"
- Training:
- Training Feature Overview: "user_guides/training/training.md"
- Reward Functions: "user_guides/training/reward_function.md"
- Agent Observations: "user_guides/training/observations.md"
- Custom Actor-Critic Policy: "user_guides/training/customactorcritic.md"
- Arena Unity Training Guide: "packages/unity/train_with_arena_unity.md"
- Arena Unity Integration: "packages/unity/training_integration.md"
- System Design:
- Overall System Design: "system/system-design.md"
- Training Pipeline: "system/training-design.md"
- Launch File System: "system/launch-file-design.md"
- Evaluation/Benchmarking Pipeline: "system/eval-design.md"
- Packages:
- Task Generator: "packages/task_generator.md"
- Flatland Simulator: "packages/flatland_simulator.md"
- Gazebo Simulator: "packages/gazebo_simulator.md"
- Arena Unity: "packages/unity/arena_unity.md"
- Pedsim Manager: "packages/pedsim_manager.md"
- Map Generator: "packages/map_generator.md"
- Arena Tools: "packages/arena_tools.md"
- Arena Simulation Setup: "packages/arena_simulation_setup.md"
- Evaluation: "packages/arena_evaluation.md"
- ROSNavRL: "packages/rosnavrl.md"
- pedsim_waypoint_plugin: "packages/pedsim_waypoint_plugin/pedsim_waypoint_plugin.md"
- Tutorials:
- Add new environment: "tutorials/add_new_environment.md"
- Train an agent with different observation spaces: "tutorials/train_agent_with_different_observation_spaces.md"
- Deploy a robot in different Gazebo Worlds: "tutorials/gazebo_tutorial/gazebo_tut.md"
- Add new reward functions: "user_guides/reward_functions.md"
- Generate a World in Gazebo: "tutorials/gazebo_tutorial/generate_world_in_gazebo.md"
- Create new scenarios: "tutorials/create_scenarios/create_new_scenarios.md"
- Create new Map Generator: "tutorials/add_map_generator.md"
# - User Guides:
# - Installation: "user_guides/installation.md"
# - Get Started: "user_guides/get_started.md"
# - Error Handling: "user_guides/error_handling.md"
# - Arena Tools: "user_guides/arena-tools.md"
# - Arena-Rosnav Overview:
# - Modular Structure: "overview/modular_structure.md"
# - Planners: "overview/planners.md"
# - Simulation Environments: "overview/simulation_environments.md"
# - General Utils: "overview/general_utils.md"
# - Core Functionalities:
# - Launching Arena-Rosnav Simulation: "core_functionalities/launch_simulation.md"
# - Training an Agent: "core_functionalities/training.md"
# - Evaluating Planner Performance: "core_functionalities/evaluation.md"
markdown_extensions:
- admonition
- tables
theme:
name: readthedocs
plugins:
- mkdocs-video:
is_video: true
video_type: webm
extra_css:
- css/extra.css
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.6.0/clipboard.min.js
- js/cpybtn.js