carla/mkdocs.yml

site_name: CARLA Simulator
repo_url: https://github.com/carla-simulator/carla
docs_dir: Docs
theme: readthedocs

pages:
- Home: 'index.md'
- Quick start:
  - 'Getting started': 'getting_started.md'
  - 'Python API tutorial': 'python_api_overview.md'
  - 'Configuring the simulation': 'configuring_the_simulation.md'
  # - 'Measurements': 'measurements.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'
  - 'Running without display and selecting GPUs': 'carla_headless.md'
  - 'Running in a Docker': 'carla_docker.md'
  - "How to link Epic's Automotive Materials": 'epic_automotive_materials.md'
- Contributing:
  - 'Contribution guidelines': 'CONTRIBUTING.md'
  - 'Coding standard': 'coding_standard.md'
  - 'Code of conduct': 'CODE_OF_CONDUCT.md'
- Development:
  - 'Map customization': 'map_customization.md'
  - 'Build system': 'build_system.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`
Enable theme in off-line mkdocs 2018-03-20 18:02:39 +08:00			`theme: readthedocs`
Add mkdocs.yml 2017-10-30 17:59:19 +08:00
			`pages:`
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'`
Fill Python API tutorial 2018-12-16 07:02:22 +08:00			`- 'Python API tutorial': 'python_api_overview.md'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- 'Configuring the simulation': 'configuring_the_simulation.md'`
Minimal documentation of the new API 2018-07-29 01:29:31 +08:00			`# - 'Measurements': 'measurements.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'`
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'`
Clean up documentation format 2018-03-22 01:16:56 +08:00			`- "How to link Epic's Automotive Materials": 'epic_automotive_materials.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'`
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:`
Map customization documentation 2017-11-18 00:21:45 +08:00			`- 'Map customization': 'map_customization.md'`
Replace Linux build system 2018-07-04 17:59:59 +08:00			`- 'Build system': 'build_system.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`