From 8f4cbf8f0f5e208aa60d020a388d302e7eebae34 Mon Sep 17 00:00:00 2001 From: nsubiron Date: Mon, 13 Nov 2017 14:01:55 +0100 Subject: [PATCH] Format documentation for readthedocs --- Docs/carla_server.md | 4 ++-- Docs/carla_settings.md | 11 +++++++---- Docs/how_to_add_automotive_materials.md | 5 +++-- Docs/how_to_build_on_linux.md | 13 ++++++------ Docs/{release_readme.md => how_to_run.md} | 5 +++-- Docs/index.md | 2 +- mkdocs.yml | 24 +++++++++++++---------- 7 files changed, 36 insertions(+), 28 deletions(-) rename Docs/{release_readme.md => how_to_run.md} (97%) diff --git a/Docs/carla_server.md b/Docs/carla_server.md index e5984876a..2fb6aa90a 100644 --- a/Docs/carla_server.md +++ b/Docs/carla_server.md @@ -6,7 +6,7 @@ Build Some scripts are provided for building and testing CarlaServer on Linux - $ Setup.sh + $ ./Setup.sh $ make $ make check @@ -85,7 +85,7 @@ non-blocking call. A CarlaServer instance is created with `carla_make_server()` and should be destroyed after use with `carla_server_free(ptr)`. -[carlaserverhlink]: ../Util/CarlaServer/include/carla/carla_server.h +[carlaserverhlink]: https://github.com/carla-simulator/carla/blob/master/Util/CarlaServer/include/carla/carla_server.h Design ------ diff --git a/Docs/carla_settings.md b/Docs/carla_settings.md index 86d50c024..e5f13faf2 100644 --- a/Docs/carla_settings.md +++ b/Docs/carla_settings.md @@ -13,8 +13,11 @@ hierarchy overriding earlier values. 3. Other command-line arguments as `-world-port`, or `-carla-no-networking` 4. Settings file sent by the client on every new episode. -Take a look at the [CARLA Settings example](Example.CarlaSettings.ini). +Take a look at the [CARLA Settings example][settingslink]. -IMPORTANT: If you are in editor, you most probably want to disable networking. -Otherwise the game will hang until a client connects. Set `UseNetworking=false` -in "./Unreal/CarlaUE4/Config/CarlaSettings.ini". +[settingslink]: https://github.com/carla-simulator/carla/blob/master/Docs/Example.CarlaSettings.ini + +!!! tip + If you are in editor, you most probably want to disable networking. + Otherwise the game will hang until a client connects. Set + `UseNetworking=false` in "./Unreal/CarlaUE4/Config/CarlaSettings.ini". diff --git a/Docs/how_to_add_automotive_materials.md b/Docs/how_to_add_automotive_materials.md index 6be7a96a5..a092c7bd3 100644 --- a/Docs/how_to_add_automotive_materials.md +++ b/Docs/how_to_add_automotive_materials.md @@ -12,8 +12,9 @@ Download from Marketplace Epic Games' [Automotive Materials][automatlink] package can be downloaded for free from the Unreal Engine Marketplace. -NOTE: Unfortunately, Unreal's Marketplace is only available on Windows, so you -need a Windows machine to download this package. +!!! note + Unfortunately, Unreal's Marketplace is only available on Windows, so you + need a Windows machine to download this package. 1. Install Epic Games Launcher from [www.unrealengine.com](https://www.unrealengine.com). 2. Buy the [Automotive Materials][automatlink] package for $0. diff --git a/Docs/how_to_build_on_linux.md b/Docs/how_to_build_on_linux.md index 82f514da7..6c57227b7 100644 --- a/Docs/how_to_build_on_linux.md +++ b/Docs/how_to_build_on_linux.md @@ -53,12 +53,11 @@ Download Epic Games' Automotive Materials package and install it under "Unreal/CarlaUE4/Content/AutomotiveMaterials". [How to download automotive materials](how_to_add_automotive_materials.md). -IMPORTANT: Do not forget to link the automotive materials after opening the -project. - -NOTE: Due to license restrictions, pedestrians are not include in the CARLA open -source project (only in the compiled binaries). Some warnings may appear when -starting the project related to this. We are working to find a solution. +!!! note + Due to license restrictions, pedestrians are not include in the CARLA open + source project (only in the compiled binaries). Some warnings may appear + when starting the project related to this. We are working to find a + solution. To build CARLA, use the rebuild script. This script deletes all intermediate files, rebuilds whole CARLA, and launches the editor. Use it too for making a @@ -70,7 +69,7 @@ It looks at the environment variable `UE4_ROOT` to find the right version of Unreal Engine. You can also add this variable to your "~/.bashrc" or similar. Once the project is opened, it is required to manually link Epic's Automotive -Material to our vehicles. +Materials to our vehicles. [How to link automotive materials](how_to_add_automotive_materials.md). Later, if you need to compile some changes without doing a full rebuild, you can diff --git a/Docs/release_readme.md b/Docs/how_to_run.md similarity index 97% rename from Docs/release_readme.md rename to Docs/how_to_run.md index 8d32a7d69..01ce40e06 100644 --- a/Docs/release_readme.md +++ b/Docs/how_to_run.md @@ -32,8 +32,9 @@ available Running the server ------------------ -IMPORTANT: By default the game starts in networking mode. It will hang until a -client is connected. See below how to run it without client. +!!! note + By default the game starts in networking mode. It will hang until a client + is connected. See below how to run it without client. The server can be started by running the `CarlaUE4.sh` script. When run in networking mode (controlled by the CARLA client), it is highly recommended to diff --git a/Docs/index.md b/Docs/index.md index 4f21bafa3..524c88067 100644 --- a/Docs/index.md +++ b/Docs/index.md @@ -3,7 +3,7 @@ CARLA Documentation #### Using CARLA - * [How to run CARLA server and client](release_readme.md) + * [How to run CARLA server and client](how_to_run.md) * [CARLA Settings](carla_settings.md) * [Troubleshooting](troubleshooting.md) diff --git a/mkdocs.yml b/mkdocs.yml index 1294e42c2..40ade388b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,16 +1,20 @@ site_name: CARLA Simulator repo_url: https://github.com/carla-simulator/carla +docs_dir: Docs pages: -- 'Home': 'Docs/index.md' -- 'CARLA Settings': 'Docs/carla_settings.md' -- 'CarlaServer documentation': 'Docs/carla_server.md' -- 'How to add Automotive Materials': 'Docs/how_to_add_automotive_materials.md' -- 'How to add assets': 'Docs/how_to_add_assets.md' -- 'How to build on Linux': 'Docs/how_to_build_on_linux.md' -- 'How to build on Windows': 'Docs/how_to_build_on_windows.md' -- 'How to run CARLA server and client': 'Docs/release_readme.md' -- 'Troubleshooting': 'Docs/troubleshooting.md' +- Home: 'index.md' +- Using CARLA: + - 'How to run CARLA server and client': 'how_to_run.md' + - 'CARLA Settings': 'carla_settings.md' + - 'Troubleshooting': 'troubleshooting.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' + - 'How to add Automotive Materials': 'how_to_add_automotive_materials.md' +- Development: + - 'How to add assets': 'how_to_add_assets.md' + - 'CarlaServer documentation': 'carla_server.md' markdown_extensions: -- admonition + - admonition