From 39e77833c7284bce57d2d5ae1ad747977a023322 Mon Sep 17 00:00:00 2001
From: Tim Besard <tim.besard@gmail.com>
Date: Tue, 11 Dec 2018 15:48:07 +0100
Subject: [PATCH] Fix documentation.

---
 .gitlab-ci.yml    | 11 -----------
 .travis.yml       | 14 +++++++++++---
 README.md         | 18 +++++++++++++-----
 docs/Project.toml |  3 ---
 docs/make.jl      | 17 ++++++++++-------
 docs/mkdocs.yml   | 24 ------------------------
 6 files changed, 34 insertions(+), 53 deletions(-)
 delete mode 100644 docs/mkdocs.yml

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 72d343c0..6eda8b62 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,16 +1,11 @@
 variables:
   CI_IMAGE_TAG: 'plain'
 
-stages:
-  - test
-  - postprocess
-
 include:
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/common.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/test_v1.0.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/test_dev.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/coverage_dev.yml'
-  - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/dev/documentation_v1.0.yml'
 
 test:v1.0:
   only:
@@ -25,12 +20,6 @@ test:dev:
     - staging
     - trying
 
-documentation:
-  only:
-    - master
-    - staging
-    - trying
-
 coverage:
   only:
     - master
diff --git a/.travis.yml b/.travis.yml
index e28663e8..d22c9933 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -23,6 +23,14 @@ branches:
 notifications:
   email: false
 
-after_success:
-  - julia -e 'ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
-  - julia -e 'cd(Pkg.dir("GPUArrays")); include(joinpath("docs", "make.jl"))'
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.0
+      os: linux
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                               Pkg.build();
+                                               Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip
diff --git a/README.md b/README.md
index eca739ca..0d52a4ce 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,22 @@
 # GPUArrays
 
-[![](https://codecov.io/gh/JuliaGPU/GPUArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaGPU/GPUArrays.jl)
-[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaGPU.github.io/GPUArrays.jl/latest)
+*Abstract GPU Array package for Julia's various GPU backends.*
+
+[![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url]
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: http://JuliaGPU.github.io/GPUArrays.jl/stable
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: http://JuliaGPU.github.io/GPUArrays.jl/dev
 
 
 [Benchmarks](https://github.com/JuliaGPU/GPUBenchmarks.jl/blob/master/results/results.md)
 
-Abstract GPU Array package for Julia's various GPU backends.
-See it as a Julia Base.AbstractArray for GPUs.
-Currently, you either need to install [CLArrays](https://github.com/JuliaGPU/CLArrays.jl) or [CuArrays](https://github.com/JuliaGPU/CuArrays.jl) for a concrete implementation.
+This package is the counterpart of Julia's `Base.AbstractArray` interface, but
+for GPU arary types. Currently, you either need to install
+[CLArrays](https://github.com/JuliaGPU/CLArrays.jl) or
+[CuArrays](https://github.com/JuliaGPU/CuArrays.jl) for a concrete
+implementation.
 
 
 # Why another GPU array package in yet another language?
diff --git a/docs/Project.toml b/docs/Project.toml
index 53bc6f84..dfa65cd1 100644
--- a/docs/Project.toml
+++ b/docs/Project.toml
@@ -1,5 +1,2 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-
-[compat]
-Documenter = "~0.19"
diff --git a/docs/make.jl b/docs/make.jl
index 9dd5cc4d..ce54af04 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -1,12 +1,15 @@
 using Documenter, GPUArrays
 
-makedocs()
+makedocs(
+    modules = [GPUArrays],
+    format = Documenter.HTML(),
+    sitename = "GPUArrays.jl",
+    pages = [
+        "Home" => "index.md",
+    ],
+    doctest = true
+)
 
 deploydocs(
-    repo   = "github.com/JuliaGPU/GPUArrays.jl.git",
-    julia  = "0.7",
-    osname = "linux",
-    # no need to build anything here, re-use output of `makedocs`
-    deps   = nothing,
-    make   = nothing,
+    repo   = "github.com/JuliaGPU/GPUArrays.jl.git"
 )
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
deleted file mode 100644
index 25ff11a0..00000000
--- a/docs/mkdocs.yml
+++ /dev/null
@@ -1,24 +0,0 @@
-site_name:        GPUArrays.jl
-repo_url:         https://github.com/JuliaGPU/GPUArrays.jl
-site_description: Abstract GPU Array implementation
-site_author:      JuliaGPU
-
-theme: cinder
-
-extra_css:
-  - assets/Documenter.css
-
-extra_javascript:
-  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML
-  - assets/mathjaxhelper.js
-
-markdown_extensions:
-  - extra
-  - tables
-  - fenced_code
-  - mdx_math
-
-docs_dir: 'build'
-
-pages:
-  - Home: index.md