Enable Travis CI and build documentation (#21)

Author: nalimilan

.travis.yml

@@ -0,0 +1,54 @@
+language: julia
+
+os:
+  - linux
+  - osx
+  - windows
+
+arch:
+  - amd64
+  - i386
+  - arm64
+
+julia:
+  - 1.3
+  - 1.4
+  - nightly
+
+notifications:
+  email: false
+
+script:
+  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
+  # Needed to take precedence on Julia's version of Statistics
+  - julia -e 'using UUIDs; write("Project.toml", replace(read("Project.toml", String), r"uuid = .*?\n" =>"uuid = \"$(uuid4())\"\n"))'
+  - julia --project --check-bounds=yes -e 'import Pkg; Pkg.build();
+                                           using Statistics;
+                                           @assert pathof(Statistics) == joinpath(pwd(), "src", "Statistics.jl");
+                                           Pkg.test(; coverage=true)'
+
+after_success:
+  - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())';
+
+jobs:
+  exclude:
+    - os: osx
+      arch: i386
+    - os: osx
+      arch: arm64
+    - os: windows
+      arch: arm64
+  include:
+    - stage: "Documentation"
+      os: linux
+      julia: 1.3
+      script:
+        # Needed to take precedence on Julia's version of Statistics
+        - julia -e 'using UUIDs; write("Project.toml", replace(read("Project.toml", String), r"uuid = .*?\n" =>"uuid = \"$(uuid4())\"\n"))'
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                    Pkg.instantiate();
+                                    using Statistics;
+                                    @assert pathof(Statistics) == joinpath(pwd(), "src", "Statistics.jl");'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip
+

docs/Project.toml

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

docs/make.jl

@@ -0,0 +1,16 @@
+using Documenter, Statistics
+
+# Workaround for JuliaLang/julia/pull/28625
+if Base.HOME_PROJECT[] !== nothing
+    Base.HOME_PROJECT[] = abspath(Base.HOME_PROJECT[])
+end
+
+makedocs(
+    modules = [Statistics],
+    sitename = "Statistics",
+    pages = Any[
+        "Statistics" => "index.md"
+        ]
+    )
+
+deploydocs(repo = "github.com/JuliaLang/Statistics.jl.git")

docs/src/index.md

@@ -1,22 +1,19 @@
 # Statistics
 
-The Statistics module contains basic statistics functionality.
-
-!!! note
-    To use any of the examples described below, run `using Statistics` and then the code from the example.
+The Statistics standard library module contains basic statistics functionality.
 
 ```@docs
-Statistics.std
-Statistics.stdm
-Statistics.var
-Statistics.varm
-Statistics.cor
-Statistics.cov
-Statistics.mean!
-Statistics.mean
-Statistics.median!
-Statistics.median
-Statistics.middle
-Statistics.quantile!
-Statistics.quantile
+std
+stdm
+var
+varm
+cor
+cov
+mean!
+mean
+median!
+median
+middle
+quantile!
+quantile
 ```

src/Statistics.jl

@@ -29,6 +29,8 @@ Compute the mean of all elements in a collection.
 
 # Examples
 ```jldoctest
+julia> using Statistics
+
 julia> mean(1:20)
 10.5
 
@@ -47,6 +49,8 @@ mean(itr) = mean(identity, itr)
 Apply the function `f` to each element of collection `itr` and take the mean.
 
 ```jldoctest
+julia> using Statistics
+
 julia> mean(√, [1, 2, 3])
 1.3820881233139908
 
@@ -83,6 +87,8 @@ Apply the function `f` to each element of array `A` and take the mean over dimen
     This method requires at least Julia 1.3.
 
 ```jldoctest
+julia> using Statistics
+
 julia> mean(√, [1, 2, 3])
 1.3820881233139908
 
@@ -107,6 +113,8 @@ Compute the mean of `v` over the singleton dimensions of `r`, and write results
 
 # Examples
 ```jldoctest
+julia> using Statistics
+
 julia> v = [1 2; 3 4]
 2×2 Array{Int64,2}:
  1  2
@@ -139,6 +147,8 @@ Compute the mean of an array over the given dimensions.
 
 # Examples
 ```jldoctest
+julia> using Statistics
+
 julia> A = [1 2; 3 4]
 2×2 Array{Int64,2}:
  1  2
@@ -720,6 +730,8 @@ Compute the middle of a range, which consists of computing the mean of its extre
 Since a range is sorted, the mean is performed with the first and last element.
 
 ```jldoctest
+julia> using Statistics
+
 julia> middle(1:10)
 5.5
 ```
@@ -733,6 +745,8 @@ Compute the middle of an array `a`, which consists of finding its
 extrema and then computing their mean.
 
 ```jldoctest
+julia> using Statistics
+
 julia> a = [1,2,3.6,10.9]
 4-element Array{Float64,1}:
   1.0
@@ -782,6 +796,8 @@ equivalent to calculating mean of two median elements.
 
 # Examples
 ```jldoctest
+julia> using Statistics
+
 julia> median([1, 2, 3])
 2.0
 
@@ -803,7 +819,9 @@ median(itr) = median!(collect(itr))
 Compute the median of an array along the given dimensions.
 
 # Examples
-```jldoctest
+```jl
+julia> using Statistics
+
 julia> median([1 2; 3 4], dims=1)
 1×2 Array{Float64,2}:
  2.0  3.0
@@ -838,6 +856,8 @@ for `k = 1:n` where `n = length(v)`. This corresponds to Definition 7 of Hyndman
 
 # Examples
 ```jldoctest
+julia> using Statistics
+
 julia> x = [3, 2, 1];
 
 julia> quantile!(x, 0.5)
@@ -950,6 +970,8 @@ for `k = 1:n` where `n = length(itr)`. This corresponds to Definition 7 of Hyndm
 
 # Examples
 ```jldoctest
+julia> using Statistics
+
 julia> quantile(0:20, 0.5)
 10.0