Merge pull request #21 from sisl/documentation

Preliminary Documentation pages

.gitignore

@@ -1,3 +1,4 @@
 *.jl.cov
 *.jl.mem
 **/.ipynb_checkpoints
+docs/build/

.travis.yml

@@ -21,3 +21,18 @@ notifications:
   # - julia --project --check-bounds=yes -e 'using Pkg; Pkg.add(PackageSpec(url="https://github.com/sisl/Vec.jl")); Pkg.add(PackageSpec(url="https://github.com/sisl/Records.jl")); Pkg.add(PackageSpec(url="https://github.com/sisl/AutomotiveDrivingModels.jl")); Pkg.build("AutoViz"); Pkg.test("AutoViz"; coverage=true)'
 after_success:
   - julia --project -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
+
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.0
+      os: linux
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.add("Documenter");
+                                               Pkg.add(PackageSpec(url="https://github.com/sisl/Vec.jl")); 
+                                               Pkg.add(PackageSpec(url="https://github.com/sisl/Records.jl")); 
+                                               Pkg.add(PackageSpec(url="https://github.com/sisl/AutomotiveDrivingModels.jl"));
+                                               Pkg.develop(PackageSpec(path=pwd())); 
+                                               Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip

README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/sisl/AutoViz.jl.svg?branch=master)](https://travis-ci.org/sisl/AutoViz.jl)
 [![Coverage Status](https://coveralls.io/repos/sisl/AutoViz.jl/badge.svg)](https://coveralls.io/r/sisl/AutoViz.jl)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://sisl.github.io/AutoViz.jl/latest)
 
 A package for rendering simple scenes primarily consisting of cars on roadways using Cairo.
 

docs/make.jl

@@ -0,0 +1,9 @@
+using Documenter, AutoViz
+
+makedocs(modules = [AutoViz],
+         format = :html,
+         sitename="AutoViz.jl")
+
+deploydocs(
+    repo = "github.com/sisl/AutoViz.jl.git"
+)

docs/src/api.md

@@ -0,0 +1,7 @@
+# API
+
+List of functions and datastructure available in AutoViz
+
+```@autodocs 
+Modules = [AutoViz]
+```

docs/src/index.md

@@ -0,0 +1,6 @@
+# About
+
+This the documentation for AutoViz.jl. For now it is just a list of functions. 
+
+```@contents
+```

test/runtests.jl

@@ -8,7 +8,7 @@ using AutomotiveDrivingModels
 
 @nbinclude(joinpath(dirname(pathof(AutoViz)),"..", "notebooks", "tutorial.ipynb"))
 @nbinclude(joinpath(dirname(pathof(AutoViz)),"..", "notebooks", "overlay_tutorial.ipynb"))
-@nbinclude(joinpath(dirname(pathof(AutoViz)),"..", "doc", "AutoViz.ipynb"))
+@nbinclude(joinpath(dirname(pathof(AutoViz)),"..", "docs", "AutoViz.ipynb"))
 
 rw = gen_straight_roadway(3, 100.0)
 car = ArrowCar(0.0, 0.0, 0.0, id=1)