Merge pull request #40 from sjkelly/sjk/docs2

build and deploy docs

.travis.yml

@@ -8,6 +8,17 @@ julia:
   - nightly
 notifications:
   email: false
+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
+
 branches:
   only: # Only kick off CI for master and potential merges to master from within PRs
     - master
@@ -16,3 +27,4 @@ matrix:
     - julia: nightly
 after_success:
   - julia -e 'using Pkg; import Descartes; Pkg.add("Coverage"); using Coverage; Codecov.submit(process_folder())'
+

Manifest.toml

@@ -57,6 +57,18 @@ version = "0.0.10"
 deps = ["Random", "Serialization", "Sockets"]
 uuid = "8ba89e20-285c-5b6f-9357-94700520ee1b"
 
+[[DocStringExtensions]]
+deps = ["LibGit2", "Markdown", "Pkg", "Test"]
+git-tree-sha1 = "4d30e889c9f106a51ffa4791a88ffd4765bf20c3"
+uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+version = "0.7.0"
+
+[[Documenter]]
+deps = ["Base64", "DocStringExtensions", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "REPL", "Unicode"]
+git-tree-sha1 = "38509269fc99a9bc450fdb9e17e805021f3e5b1b"
+uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+version = "0.22.4"
+
 [[FileIO]]
 deps = ["Pkg"]
 git-tree-sha1 = "351f001a78aa1b7ad2696e386e110b5abd071c71"
@@ -90,6 +102,12 @@ git-tree-sha1 = "79246285c43602384e6f1943b3554042a3712056"
 uuid = "c8e1da08-722c-5040-9ed9-7db0dc04731e"
 version = "1.1.1"
 
+[[JSON]]
+deps = ["Dates", "Distributed", "Mmap", "Sockets", "Test", "Unicode"]
+git-tree-sha1 = "1f7a25b53ec67f5e9422f1f551ee216503f4a0fa"
+uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
+version = "0.20.0"
+
 [[LibGit2]]
 uuid = "76f85450-5226-5b5a-8eaa-529ad045b433"
 

Project.toml

@@ -3,6 +3,7 @@ uuid = "ea4ead7c-22ac-5e77-afc5-cd927cdc0b20"
 authors = ["Steve Kelly <kd2cca@gmail.com>"]
 
 [deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
 GeometryTypes = "4d00f742-c7ba-57c2-abde-4428a4b178cb"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"

README.md

@@ -1,5 +1,8 @@
 # Descartes
 
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://sjkelly.github.io/Descartes.jl/stable)
+[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://sjkelly.github.io/Descartes.jl/dev)
+
 [![Build Status](https://travis-ci.org/sjkelly/Descartes.jl.svg?branch=master)](https://travis-ci.org/sjkelly/Descartes.jl)
 [![codecov](https://codecov.io/gh/sjkelly/Descartes.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/sjkelly/Descartes.jl)
 

docs/make.jl

@@ -4,12 +4,12 @@ using Descartes
 makedocs(
     sitename = "Descartes",
     format = :html,
-    modules = [Descartes]
+    modules = [Descartes],
+    authors = "Steve Kelly",
+
 )
 
-# Documenter can also automatically deploy documentation to gh-pages.
-# See "Hosting Documentation" and deploydocs() in the Documenter manual
-# for more information.
-#=deploydocs(
-    repo = "<repository url>"
-)=#
+
+deploydocs(
+    repo = "github.com/sjkelly/Descartes.jl.git"
+)