From c3b3d3322f58c4ff24648e48f432c517075016f6 Mon Sep 17 00:00:00 2001 From: nsubiron Date: Tue, 17 Apr 2018 14:05:50 +0200 Subject: [PATCH] Add travis-ci job for testing the documentation --- .gitignore | 1 + .travis.yml | 15 +++++++++++++++ CARLA.sublime-project | 3 ++- Docs/CONTRIBUTING.md | 2 +- 4 files changed, 19 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index b1cb5f56e..eeb82282e 100644 --- a/.gitignore +++ b/.gitignore @@ -27,4 +27,5 @@ __pycache__ _benchmarks_results _images* _out +_site core diff --git a/.travis.yml b/.travis.yml index 5f123a019..acff37a08 100644 --- a/.travis.yml +++ b/.travis.yml @@ -25,3 +25,18 @@ matrix: - cppcheck script: - cppcheck . -iBuild -i.pb.cc --error-exitcode=1 --enable=warning --quiet + + - env: TEST="MkDocs" + install: + - pip install mkdocs + script: + - mkdocs build --verbose --clean --strict --site-dir _site + + - env: TEST="AwesomeBot" + install: + - gem install awesome_bot + script: + - find . -name '*.md' | xargs awesome_bot --allow-dupe --allow-redirect --skip-save-results + +notifications: + email: false diff --git a/CARLA.sublime-project b/CARLA.sublime-project index 74778e0f3..2eab9615d 100644 --- a/CARLA.sublime-project +++ b/CARLA.sublime-project @@ -18,7 +18,8 @@ "Intermediate", "Saved", "Unreal/CarlaUE4/Content*", - "__pycache__" + "__pycache__", + "_site" ], "file_exclude_patterns": [ diff --git a/Docs/CONTRIBUTING.md b/Docs/CONTRIBUTING.md index 677603064..cd966e32f 100644 --- a/Docs/CONTRIBUTING.md +++ b/Docs/CONTRIBUTING.md @@ -101,7 +101,7 @@ spawned. Note that the blueprint can call back C++ functions, for instance for getting the random engine. This way there is a back-and-forth communication between C++ code and blueprints. -[capturelink]: https://github.com/carla-simulator/carla/blob/master/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/SceneCaptureToDiskCamera.h +[capturelink]: https://github.com/carla-simulator/carla/blob/master/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/SceneCaptureToDiskCamera.h #### Coding standard