carla/mkdocs.yml

site_name: CARLA Simulator
repo_url: https://github.com/carla-simulator/carla
docs_dir: Docs
edit_uri: 'edit/master/Docs/'
theme: readthedocs
extra_css: [extra.css]

nav:
- Home: 'index.md'
- Quick start:
  - 'Getting started': 'getting_started.md'
  - 'Python API tutorial': 'python_api_tutorial.md'
  - 'Configuring the simulation': 'configuring_the_simulation.md'
  - 'Cameras and sensors': 'cameras_and_sensors.md'
  - 'F.A.Q.': 'faq.md'
- Building from source:
  - 'How to build on Linux': 'how_to_build_on_linux.md'
  - 'How to build on Windows': 'how_to_build_on_windows.md'
- Advanced topics:
  - 'Python API reference': 'python_api.md'
  - 'C++ reference' : 'cpp_reference.md'
  - 'Python Cookbook': 'python_cookbook.md'
  - 'Blueprint Library': 'bp_library.md'
  - 'Running without display and selecting GPUs': 'carla_headless.md'
  - 'Running in a Docker': 'carla_docker.md'
  - "How to create and import a new map": 'how_to_make_a_new_map.md'
  - "How to generate pedestrian navigation": 'how_to_generate_pedestrians_navigation.md'
  - "How to link Epic's Automotive Materials": 'epic_automotive_materials.md'
  - "Creating standalone asset packages for distribution": 'asset_packages_for_dist.md'
  - "How to record and replay": 'recorder_and_playback.md'
  - "Recorder binary file format": 'recorder_binary_file_format.md'
  - "How to add friction triggers": "how_to_add_friction_triggers.md"
  - "How to control vehicle physics": "how_to_control_vehicle_physics.md"
  - "How to control walker skeletons": "walker_bone_control.md"
- Contributing:
  - 'Contribution guidelines': 'CONTRIBUTING.md'
  - 'Coding standard': 'coding_standard.md'
  - 'Documentation standard': 'doc_standard.md'
  - 'Code of conduct': 'CODE_OF_CONDUCT.md'
- Development:
  - 'Index': 'dev/index.md'
  - 'Map customization': 'dev/map_customization.md'
  - 'Build system': 'dev/build_system.md'
  - 'How to add a new sensor': 'dev/how_to_add_a_new_sensor.md'
  - "How to upgrade content": 'dev/how_to_upgrade_content.md'
  - "How to make a release": 'dev/how_to_make_a_release.md'
- Art guidelines:
  - 'How to add assets': 'how_to_add_assets.md'
  - 'How to model vehicles': 'how_to_model_vehicles.md'

markdown_extensions:
  - admonition
Add mkdocs.yml 2017-10-30 17:59:19 +08:00			`site_name: CARLA Simulator`
			`repo_url: https://github.com/carla-simulator/carla`
Format documentation for readthedocs 2017-11-13 21:01:55 +08:00			`docs_dir: Docs`
Fix edit on github links 2019-06-25 18:19:30 +08:00			`edit_uri: 'edit/master/Docs/'`
Enable theme in off-line mkdocs 2018-03-20 18:02:39 +08:00			`theme: readthedocs`
Fdomf/docs (#2049) * Updated CARLA video link (README) * Updated API reference - deleted overview * Added css to docs * Added documentation standard section * Updated API docs * Updated documentation following the standard * Updated How to create map and import docs + documentation related standard + improvements * Word change * Updated importing assests from RR * Fixes and new section for pedestrian navigation * Changed image position * Updated 2019-09-06 17:07:21 +08:00			`extra_css: [extra.css]`
Add mkdocs.yml 2017-10-30 17:59:19 +08:00
Upgrade travis.yml to Ubuntu 16.04 2019-01-27 22:57:02 +08:00			`nav:`
Format documentation for readthedocs 2017-11-13 21:01:55 +08:00			`- Home: 'index.md'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- Quick start:`
			`- 'Getting started': 'getting_started.md'`
Rename Python API tutorial file 2018-12-16 07:04:30 +08:00			`- 'Python API tutorial': 'python_api_tutorial.md'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- 'Configuring the simulation': 'configuring_the_simulation.md'`
Document cameras and sensors 2017-11-17 00:26:50 +08:00			`- 'Cameras and sensors': 'cameras_and_sensors.md'`
Add empty F.A.Q. section 2017-11-25 01:12:15 +08:00			`- 'F.A.Q.': 'faq.md'`
Format documentation for readthedocs 2017-11-13 21:01:55 +08:00			`- Building from source:`
			`- 'How to build on Linux': 'how_to_build_on_linux.md'`
			`- 'How to build on Windows': 'how_to_build_on_windows.md'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- Advanced topics:`
Overview Python API doc (draft) 2018-12-13 22:47:26 +08:00			`- 'Python API reference': 'python_api.md'`
Fdomf/docs (#1948) * Added c++ doc section, Updated bp_library,docs improvements * Minor changes * Docs updates * Added c++ doc section, Updated bp_library,docs improvements * Minor changes * Docs updates * Updated jenkins file - master rebase * Fixed doxygen link * Waypoint tutorial extended and fixes * Fixes 2019-08-01 21:42:19 +08:00			`- 'C++ reference' : 'cpp_reference.md'`
Fdomf/docs (#1981) * Added c++ doc section, Updated bp_library,docs improvements * Minor changes * Docs updates * Added c++ doc section, Updated bp_library,docs improvements * Minor changes * Docs updates * Updated jenkins file - master rebase * Updated Jenkins - rebase * Fixed doxygen link * Waypoint tutorial extended and fixes * Merge branch 'master' into fdomf/docs * Fixes * Merge branch 'fdomf/docs' of https://github.com/carla-simulator/carla into fdomf/docs * Updated some python API class & methods * Merge branch 'master' into fdomf/docs * updated python api * Updates * Fixed broken link in camera&sensors doc * Python API doc updated * Added python api * Added first lite version of python cookbook and docs related links * Bp_doc_gen * Merge branch 'master' into fdomf/docs * merge master python api docs * Updated doc * make PythonApi.docs * Merge branch 'master' into fdomf/docs * Updated python API doc generator * New debug recipe * Docs fixes 2019-08-15 01:44:55 +08:00			`- 'Python Cookbook': 'python_cookbook.md'`
Fdomf/docs (#1883) * Updated documentation and improvements * Bp doc generator * Updated 2019-07-26 17:25:49 +08:00			`- 'Blueprint Library': 'bp_library.md'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- 'Running without display and selecting GPUs': 'carla_headless.md'`
adding a docker tutorial 2018-07-21 04:52:11 +08:00			`- 'Running in a Docker': 'carla_docker.md'`
Fdomf/docs (#2049) * Updated CARLA video link (README) * Updated API reference - deleted overview * Added css to docs * Added documentation standard section * Updated API docs * Updated documentation following the standard * Updated How to create map and import docs + documentation related standard + improvements * Word change * Updated importing assests from RR * Fixes and new section for pedestrian navigation * Changed image position * Updated 2019-09-06 17:07:21 +08:00			`- "How to create and import a new map": 'how_to_make_a_new_map.md'`
Fixed pedestrian mesh genereation docs 2019-12-10 01:41:57 +08:00			`- "How to generate pedestrian navigation": 'how_to_generate_pedestrians_navigation.md'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- "How to link Epic's Automotive Materials": 'epic_automotive_materials.md'`
Updated doc and refactor 2019-07-10 05:46:28 +08:00			`- "Creating standalone asset packages for distribution": 'asset_packages_for_dist.md'`
Renamed and reordered index files 2019-07-09 00:00:05 +08:00			`- "How to record and replay": 'recorder_and_playback.md'`
			`- "Recorder binary file format": 'recorder_binary_file_format.md'`
Updated physics, control and weather documentation 2019-06-06 22:58:48 +08:00			`- "How to add friction triggers": "how_to_add_friction_triggers.md"`
			`- "How to control vehicle physics": "how_to_control_vehicle_physics.md"`
Fix walker_bone_control.md not added to index 2019-07-01 19:04:32 +08:00			`- "How to control walker skeletons": "walker_bone_control.md"`
Add contributing guide 2017-12-04 23:18:14 +08:00			`- Contributing:`
Change contribution guide to guidelines 2017-12-04 23:25:55 +08:00			`- 'Contribution guidelines': 'CONTRIBUTING.md'`
Improve contribution guidelines 2018-01-18 01:11:57 +08:00			`- 'Coding standard': 'coding_standard.md'`
Fdomf/docs (#2049) * Updated CARLA video link (README) * Updated API reference - deleted overview * Added css to docs * Added documentation standard section * Updated API docs * Updated documentation following the standard * Updated How to create map and import docs + documentation related standard + improvements * Word change * Updated importing assests from RR * Fixes and new section for pedestrian navigation * Changed image position * Updated 2019-09-06 17:07:21 +08:00			`- 'Documentation standard': 'doc_standard.md'`
Add code of conduct 2018-01-16 23:09:30 +08:00			`- 'Code of conduct': 'CODE_OF_CONDUCT.md'`
Format documentation for readthedocs 2017-11-13 21:01:55 +08:00			`- Development:`
Move development docs to their folder 2019-07-01 19:04:09 +08:00			`- 'Index': 'dev/index.md'`
			`- 'Map customization': 'dev/map_customization.md'`
			`- 'Build system': 'dev/build_system.md'`
Tutorial for adding new sensors (#1884) * Tutorial for adding new sensors * Updated doc 2019-09-02 16:01:41 +08:00			`- 'How to add a new sensor': 'dev/how_to_add_a_new_sensor.md'`
Move development docs to their folder 2019-07-01 19:04:09 +08:00			`- "How to upgrade content": 'dev/how_to_upgrade_content.md'`
			`- "How to make a release": 'dev/how_to_make_a_release.md'`
Add 'Art guidelines' section to docs 2018-08-24 17:23:49 +08:00			`- Art guidelines:`
			`- 'How to add assets': 'how_to_add_assets.md'`
			`- 'How to model vehicles': 'how_to_model_vehicles.md'`
Fixing mkdocs issue 2018-04-17 18:22:07 +08:00
Add mkdocs.yml 2017-10-30 17:59:19 +08:00			`markdown_extensions:`
Format documentation for readthedocs 2017-11-13 21:01:55 +08:00			`- admonition`