From 7c7045859e37f1f69a320b8a085a97ff9c07dc19 Mon Sep 17 00:00:00 2001 From: MaximeBouton Date: Fri, 1 Mar 2019 17:01:02 -0800 Subject: [PATCH 1/6] preliminary doc --- .gitignore | 1 + .travis.yml | 11 +++++++++++ {doc => docs}/.gitignore | 0 {doc => docs}/AutoViz.ipynb | 0 docs/make.jl | 9 +++++++++ docs/src/api.md | 7 +++++++ docs/src/index.md | 6 ++++++ 7 files changed, 34 insertions(+) rename {doc => docs}/.gitignore (100%) rename {doc => docs}/AutoViz.ipynb (100%) create mode 100644 docs/make.jl create mode 100644 docs/src/api.md create mode 100644 docs/src/index.md diff --git a/.gitignore b/.gitignore index dcba3e2..7d9a08e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ *.jl.cov *.jl.mem **/.ipynb_checkpoints +docs/build/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index 6765d2f..a09d48a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -21,3 +21,14 @@ 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.develop(PackageSpec(path=pwd())); + Pkg.instantiate()' + - julia --project=docs/ docs/make.jl + after_success: skip \ No newline at end of file diff --git a/doc/.gitignore b/docs/.gitignore similarity index 100% rename from doc/.gitignore rename to docs/.gitignore diff --git a/doc/AutoViz.ipynb b/docs/AutoViz.ipynb similarity index 100% rename from doc/AutoViz.ipynb rename to docs/AutoViz.ipynb diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..5457b26 --- /dev/null +++ b/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" +) \ No newline at end of file diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 0000000..153a48e --- /dev/null +++ b/docs/src/api.md @@ -0,0 +1,7 @@ +# API + +List of functions and datastructure available in AutoViz + +```@autodocs +Modules = [AutoViz] +``` \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000..4b2ccfb --- /dev/null +++ b/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 +``` \ No newline at end of file From da0ac402da266c635c37b210c3cc4938a03c6dce Mon Sep 17 00:00:00 2001 From: MaximeBouton Date: Fri, 1 Mar 2019 17:12:58 -0800 Subject: [PATCH 2/6] fix path to notebook --- test/runtests.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/runtests.jl b/test/runtests.jl index d2b5fc2..deb3bc0 100644 --- a/test/runtests.jl +++ b/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) From 6589a6515d220dbbed168f74cc8560ba7908948d Mon Sep 17 00:00:00 2001 From: MaximeBouton Date: Fri, 1 Mar 2019 17:18:06 -0800 Subject: [PATCH 3/6] add build command in travis doc --- .travis.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index a09d48a..a704170 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,7 +28,8 @@ jobs: julia: 1.0 os: linux script: - - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); + - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); + Pkg.build(PackageSpec(path=pwd())); Pkg.instantiate()' - julia --project=docs/ docs/make.jl after_success: skip \ No newline at end of file From be31e19c518b7df4466d9f03a2b4f431a75968d1 Mon Sep 17 00:00:00 2001 From: MaximeBouton Date: Fri, 1 Mar 2019 17:32:23 -0800 Subject: [PATCH 4/6] travis build --- .travis.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index a704170..578dc95 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,8 +28,10 @@ jobs: julia: 1.0 os: linux script: - - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); - Pkg.build(PackageSpec(path=pwd())); + - julia --project=docs/ -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.develop(PackageSpec(path=pwd())); Pkg.instantiate()' - julia --project=docs/ docs/make.jl after_success: skip \ No newline at end of file From ddb9895f775d16b94a569aa6cc6dbc0f13a3169c Mon Sep 17 00:00:00 2001 From: MaximeBouton Date: Fri, 1 Mar 2019 17:32:33 -0800 Subject: [PATCH 5/6] doc badge --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f9f5c62..cc9518f 100644 --- a/README.md +++ b/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. From 5e7e5d21f63e234e03d44fc721f46ba6bbd54456 Mon Sep 17 00:00:00 2001 From: MaximeBouton Date: Fri, 1 Mar 2019 17:40:20 -0800 Subject: [PATCH 6/6] add documenter to travis --- .travis.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 578dc95..c5bf5d7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,7 +28,8 @@ jobs: julia: 1.0 os: linux script: - - julia --project=docs/ -e 'using Pkg; Pkg.add(PackageSpec(url="https://github.com/sisl/Vec.jl")); + - 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()));