Add benchmark to documentation

2017-12-22 18:38:10 +01:00 · 2017-12-22 18:38:10 +01:00 · 5067b9109e
parent 99ef016f2e
commit 5067b9109e
3 changed files with 6 additions and 0 deletions
--- a/Docs/carla_benchmark.md
+++ b/Docs/carla_benchmark.md
@ -1,6 +1,10 @@
 CARLA Benchmark
 ===============

+!!! important
+    Benchmark code is currently in beta and can be found only in the
+    `benchmark_branch`.
+
 Running the Benchmark
 ---------------------

--- a/Docs/index.md
+++ b/Docs/index.md
@ -8,6 +8,7 @@ CARLA Documentation
  * [CARLA settings](carla_settings.md)
  * [Measurements](measurements.md)
  * [Cameras and sensors](cameras_and_sensors.md)
+  * [Benchmark](benchmark.md)
  * [F.A.Q.](faq.md)
  * [Troubleshooting](troubleshooting.md)

--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -9,6 +9,7 @@ pages:
  - 'CARLA Settings': 'carla_settings.md'
  - 'Measurements': 'measurements.md'
  - 'Cameras and sensors': 'cameras_and_sensors.md'
+  - 'Benchmark': 'benchmark.md'
  - 'F.A.Q.': 'faq.md'
  - 'Troubleshooting': 'troubleshooting.md'
 - Building from source: