update documentation

Author: bhgomes

.appveyor.yml

@@ -0,0 +1,37 @@
+environment:
+  matrix:
+  - julia_version: 1.0
+  - julia_version: 1.1
+  - julia_version: 1.2
+  - julia_version: 1.3
+  - julia_version: nightly
+
+platform:
+  - x86
+  - x64
+
+matrix:
+  allow_failures:
+    - julia_version: nightly
+
+branches:
+  only:
+    - master
+    - /release-.*/
+
+notifications:
+  - provider: Email
+    on_build_success: false
+    on_build_failure: false
+    on_build_status_changed: false
+
+install:
+  - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
+
+build_script:
+  - echo "%JL_BUILD_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
+
+test_script:
+  - echo "%JL_TEST_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.travis.yml

@@ -1,11 +1,37 @@
 language: julia
+
 os:
-  - linux
   - osx
+  - linux
+
 julia:
   - 1.0
   - 1.1
   - 1.2
   - 1.3
+  - nightly
+
+matrix:
+  allow_failures:
+    - julia: nightly
+
 notifications:
   email: false
+
+script:
+  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
+  - julia --project -e 'using Pkg; Pkg.build(); Pkg.test(; coverage=true)';
+
+after_success:
+  - julia -e 'using 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.instantiate();
+                                    Pkg.develop(PackageSpec(path=pwd()))'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip

README.md

@@ -5,6 +5,9 @@
 [![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://bhgomes.github.io/SubTypes.jl/stable)
 [![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://bhgomes.github.io/SubTypes.jl/latest)
 [![Travis Build Status](https://travis-ci.com/bhgomes/SubTypes.jl.svg?branch=master)](https://travis-ci.com/bhgomes/SubTypes.jl)
+[![Build status](https://ci.appveyor.com/api/projects/status/9q43kym8re2rw92f?svg=true)](https://ci.appveyor.com/project/bhgomes/subtypes-jl)
+[![Formatting](https://img.shields.io/badge/format-tab%204%20margin%2096-888)](https://github.com/domluna/JuliaFormatter.jl)
+[![GitHub Repo](https://img.shields.io/badge/repo-GitHub-black)](https://github.com/bhgomes/SubTypes.jl)
 
 _Custom Subtyping in Julia_
 
@@ -59,7 +62,7 @@ support(::Constrained{T, S}) = S
 To install, run the following in a Julia session:
 
 ```julia
-]add SubTypes
+]add https://github.com/bhgomes/SubTypes.jl
 ```
 
 ---

docs/Project.toml

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

docs/make.jl

@@ -0,0 +1,26 @@
+# docs/make.jl
+# Make Documentation for SubTypes.jl
+
+push!(LOAD_PATH, "../src/")
+
+using Documenter, SubTypes
+
+makedocs(
+    modules   = [SubTypes],
+    doctest   = true,
+    clean     = false,
+    linkcheck = false,
+    format    = Documenter.HTML(prettyurls=!("local" in ARGS)),
+    sitename  = "SubTypes.jl",
+    authors   = "Brandon H Gomes",
+    pages     = [
+        "Home" => "index.md",
+    ],
+)
+
+deploydocs(
+    repo = "github.com/bhgomes/SubTypes.jl.git",
+    target = "build",
+    deps = nothing,
+    make = nothing,
+)

docs/src/index.md

@@ -0,0 +1,11 @@
+# SubTypes.jl
+
+_Custom Subtyping in Julia_
+
+[![Travis Build Status](https://travis-ci.com/bhgomes/SubTypes.jl.svg?branch=master)](https://travis-ci.com/bhgomes/SubTypes.jl)
+
+**WIP**
+
+---
+##### [(UN)LICENSE](../../UNLICENSE)
+Knowledge is Freedom.

src/SubTypes.jl

@@ -1,38 +1,33 @@
 # src/SubTypes.jl
-# Custom subtyping in Julia
+# Custom Subtyping in Julia
 
 __precompile__(true)
 
 """```
 SubTypes
 ```
 Custom Subtypes in Julia.
+See https://github.com/bhgomes/SubTypes.jl for more details.
 """
 module SubTypes
 
 import Base: convert, eltype
 
-export SubType,
-       check_predicate,
-       predicate,
-       context,
-       Constrained,
-       ConstrainedSymbol,
-       support
+export SubType, check_predicate, predicate, context, Constrained, ConstrainedSymbol, support
 
 
 """```
 SubType{T, P, Ctx}
 ```
 Subtype structure with underlying type `T`, predicate `P`, and context `Ctx`.
 """
-struct SubType{T, P, Ctx}
+struct SubType{T,P,Ctx}
     value::T
-    SubType{T}(x::T) where {T} = new{T, Any, nothing}(x)
-    SubType{T, Any}(x::T) where {T} = new{T, Any, nothing}(x)
-    function SubType{T, P, Ctx}(x::T) where {T, P, Ctx}
+    SubType{T}(x::T) where {T} = new{T,Any,nothing}(x)
+    SubType{T,Any}(x::T) where {T} = new{T,Any,nothing}(x)
+    function SubType{T,P,Ctx}(x::T) where {T,P,Ctx}
         check_predicate(P, Val(Ctx), x)
-        return new{T, P, Ctx}(x)
+        return new{T,P,Ctx}(x)
     end
 end
 
@@ -42,9 +37,8 @@ check_predicate(P, Val(Ctx), x)
 ```
 Check that `x` satisfies the predicate `P` in context `Ctx`.
 """
-function check_predicate(P, ::Val{Ctx}, x)
-    throw(ArgumentError(
-        "`$x` does not match the predicate `$P` in context `$Ctx`"))
+function check_predicate(P, ::Val{Ctx}, x) where {Ctx}
+    throw(ArgumentError("`$x` does not match the predicate `$P` in context `$Ctx`"))
 end
 
 
@@ -77,7 +71,7 @@ predicate(::Type{SubType{T, P}}) === P
 ```
 Return the `predicate` of the `SubType` type.
 """
-predicate(::Type{SubType{T, P}}) where {T, P} = P
+predicate(::Type{SubType{T,P}}) where {T,P} = P
 
 
 """```
@@ -93,7 +87,7 @@ context(::Type{SubType{T, P, Ctx}}) === Ctx
 ```
 Return the `context` of the `SubType` type.
 """
-context(::Type{SubType{T, P, Ctx}}) where {T, P, Ctx} = Ctx
+context(::Type{SubType{T,P,Ctx}}) where {T,P,Ctx} = Ctx
 
 
 """```
@@ -110,15 +104,15 @@ Constrained{T, S} === SubType{T, S, :Constrained}
 Constrained types emulate subset inclusion types. That is
 `x::Constrained{T,S} <=> x.value::T in S`.
 """
-const Constrained{T, S} = SubType{T, S, :Constrained}
+const Constrained{T,S} = SubType{T,S,:Constrained}
 
 
 """```
 ConstrainedSymbol{S} === Constrained{Symbol, S}
 ```
 Constrained symbols are the constrained type of `Symbol`s.
 """
-const ConstrainedSymbol{S} = Constrained{Symbol, S}
+const ConstrainedSymbol{S} = Constrained{Symbol,S}
 
 
 """```
@@ -139,7 +133,7 @@ support(::Type{Constrained{T, S}}) = S
 Return the set which defines the predicate, i.e. the support of the
 indicator function on `S`.
 """
-support(::Type{Constrained{T, S}}) where {T, S} = S
+support(::Type{Constrained{T,S}}) where {T,S} = S
 
 
 """```