carla/mkdocs.yml

60 lines
2.4 KiB
YAML
Raw Normal View History

2017-10-30 17:59:19 +08:00
site_name: CARLA Simulator
repo_url: https://github.com/carla-simulator/carla
2017-11-13 21:01:55 +08:00
docs_dir: Docs
2019-06-25 18:19:30 +08:00
edit_uri: 'edit/master/Docs/'
2018-03-20 18:02:39 +08:00
theme: readthedocs
extra_css: [extra.css]
2017-10-30 17:59:19 +08:00
2019-01-27 22:57:02 +08:00
nav:
2017-11-13 21:01:55 +08:00
- Home: 'index.md'
- Getting started:
- 'Introduction': 'getting_started/introduction.md'
- 'Quick start': 'getting_started/quickstart.md'
- Building CARLA:
- 'Linux build': 'how_to_build_on_linux.md'
- 'Windows build': 'how_to_build_on_windows.md'
- 'Update CARLA': 'update_carla.md'
- 'Build system': 'dev/build_system.md'
- 'Running in a Docker': 'carla_docker.md'
- 'F.A.Q.': 'faq.md'
- First steps:
2020-02-19 17:10:48 +08:00
- 'Core concepts': 'core_concepts.md'
- '1st. World and client': 'core_world.md'
- '2nd. Actors and blueprints': 'core_actors.md'
- '3rd. Maps and navigation': 'core_map.md'
- '4th. Sensors and data': 'cameras_and_sensors.md'
- Advanced steps:
- 'Recorder': 'recorder_and_playback.md'
- 'Rendering options': 'rendering_options.md'
- 'Synchrony and time-step': 'simulation_time_and_synchrony.md'
- References:
- 'Python API reference': 'python_api.md'
2020-02-19 17:10:48 +08:00
- 'Code recipes': 'python_cookbook.md'
- 'Blueprint Library': 'bp_library.md'
- 'C++ reference' : 'cpp_reference.md'
2020-02-19 17:10:48 +08:00
- 'Recorder binary file format': 'recorder_binary_file_format.md'
- How to... (general):
- 'Add a new sensor': 'dev/how_to_add_a_new_sensor.md'
2020-02-19 17:10:48 +08:00
- 'Add friction triggers': "how_to_add_friction_triggers.md"
- 'Control vehicle physics': "how_to_control_vehicle_physics.md"
- 'Control walker skeletons': "walker_bone_control.md"
- 'Creating standalone asset packages for distribution': 'asset_packages_for_dist.md'
- 'Generate pedestrian navigation': 'how_to_generate_pedestrians_navigation.md'
- "Link Epic's Automotive Materials": 'epic_automotive_materials.md'
- 'Map customization': 'dev/map_customization.md'
- 'Running without display and selecting GPUs': 'carla_headless.md'
- How to... (content):
- 'Add assets': 'how_to_add_assets.md'
2020-02-19 17:10:48 +08:00
- 'Create and import a new map': 'how_to_make_a_new_map.md'
- 'Model vehicles': 'how_to_model_vehicles.md'
2017-12-04 23:18:14 +08:00
- Contributing:
- 'Contribution guidelines': 'CONTRIBUTING.md'
2018-01-18 01:11:57 +08:00
- 'Coding standard': 'coding_standard.md'
- 'Documentation standard': 'doc_standard.md'
2020-02-19 17:10:48 +08:00
- 'Make a release': 'dev/how_to_make_a_release.md'
- 'Upgrade the content': 'dev/how_to_upgrade_content.md'
2018-01-16 23:09:30 +08:00
- 'Code of conduct': 'CODE_OF_CONDUCT.md'
2018-04-17 18:22:07 +08:00
2017-10-30 17:59:19 +08:00
markdown_extensions:
2017-11-13 21:01:55 +08:00
- admonition