Merge pull request #6 from sisl/fix_travis

Travis tests triggered, and docs also work

.travis.yml

@@ -1,26 +1,18 @@
 # Documentation: http://docs.travis-ci.com/user/languages/julia/
 language: julia
 sudo: required
+
 os:
   - linux
+  - osx 
 
 julia:
   - 1
 
-addons:
- apt: # apt-get for linux
-   packages:
-   - libgtk-3-dev
 notifications:
   email: false
 
-script:
-  - git clone https://github.com/JuliaRegistries/General  $(julia -e 'import Pkg; println(joinpath(Pkg.depots1(), "registries", "General"))')  
-  - git clone https://github.com/SISL/Registry  $(julia -e 'import Pkg; println(joinpath(Pkg.depots1(), "registries", "SISL"))')  
-  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
-  - julia --project --color=yes -e 'import Pkg; Pkg.build(); Pkg.test(coverage=true)'
 after_success:
-  - julia --project -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
   - julia --project -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
 
 jobs:
@@ -29,8 +21,6 @@ jobs:
       julia: 1
       os: linux
       script:
-        - git clone https://github.com/JuliaRegistries/General  $(julia -e 'import Pkg; println(joinpath(Pkg.depots1(), "registries", "General"))')  
-        - git clone https://github.com/SISL/Registry  $(julia -e 'import Pkg; println(joinpath(Pkg.depots1(), "registries", "SISL"))')  
         - julia --project=docs/ -e 'using Pkg; Pkg.add("Documenter")'
         - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
                                                Pkg.instantiate()'

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/src/driving_simulation.md

@@ -1,15 +1,17 @@
 # Driving Simulation
+These functions help in running driving simulations.
+
 ```@docs
-    keep_vehicle_subset!,
-    make_def_models,
-    make_IDM_models,
-    make_cidm_models,
-    make_iidm_models,
-    make_TimLaneChanger_models,
-    get_hallucination_scenes,
-    run_vehicles,
-    compare2truth,
-    run_vehicles_curvept_overlay,
-    test_barrier_vehicle,
+    keep_vehicle_subset!
+    make_def_models
+    make_IDM_models
+    make_cidm_models
+    make_iidm_models
+    make_TimLaneChanger_models
+    get_hallucination_scenes
+    run_vehicles
+    compare2truth
+    run_vehicles_curvept_overlay
+    test_barrier_vehicle
     test_jumpy_vehicle
 ```

docs/src/roadway_building.md

@@ -1,16 +1,17 @@
 # Roadway Building
+These functions are required to build the roadway from the provided centerline text files.
 
 ```@docs
-    append_to_curve!,
-    get_new_angle,
-    bound_heading,
-    append_headings,
-    centerlines_txt2tracks,
-    make_roadway_interaction,
-    make_roadway_ngsim,
-    make_roadway_interaction_with_extensions,
-    make_discont_roadway_straight,
-    make_discont_roadway_jagged,
-    MergingRoadway,
+    append_to_curve!
+    get_new_angle
+    bound_heading
+    append_headings
+    centerlines_txt2tracks
+    make_roadway_interaction
+    make_roadway_ngsim
+    make_roadway_interaction_with_extensions
+    make_discont_roadway_straight
+    make_discont_roadway_jagged
+    MergingRoadway
     add_renderable!
 ```

docs/src/veh_track_reading.md

@@ -1,7 +1,9 @@
 # Vehicle Track Reading
+These functions are responsible for reading vehicle track information from provided csv file into a vector of scenes, a format compatible with `AutomotiveSimulator.jl`
+
 ```@docs
-    INTERACTIONTrajdata,
-    carsinframe,
-    car_df_index,
+    INTERACTIONTrajdata
+    carsinframe
+    car_df_index
     read_veh_tracks
-```
+```

docs/src/visualization.md

@@ -1,9 +1,9 @@
 # Visualization
+These functions are responsible to create visualizations using `AutomotiveVisualization.jl`.
+
 ```@docs
-    video_trajdata_replay,
-    scenelist2video,
-    video_overlay_scenelists,
-    curvepts_overlay,
-    LaneOverlay,
+    video_trajdata_replay
+    scenelist2video
+    video_overlay_scenelists
     scenelist2video_curvepts
-```
+```

src/AutomotiveInteraction.jl

@@ -53,8 +53,6 @@ export
     video_trajdata_replay,
     scenelist2video,
     video_overlay_scenelists,
-    curvepts_overlay,
-    LaneOverlay,
     scenelist2video_curvepts
 include("visualization.jl")
 

src/roadway_building.jl

@@ -392,6 +392,9 @@ struct MergingRoadway
     roadway::Roadway
 end
 
+"""
+Dedicated render function for the MergingRoadway wrapper
+"""
 function AutomotiveVisualization.add_renderable!(rendermodel::RenderModel,
     mr::MergingRoadway)
     #print("This is the (still code copied) rendering for merging lane boundary")