Merge pull request #167 from JuliaGPU/dpa/deploy-docs

Deploy the docs to GitHub Pages

Author: vchuravy

README.md

@@ -2,6 +2,7 @@ KernelAbstractions.jl
 ==============
 *Ash dushum durbatulûk, ash dushum gimbatul, ash dushum thrakatulûk, agh burzum-ishi krimpatul*
 
+[![Documentation (stable)][docs-stable-img]][docs-stable-url]
 [![Documentation (latest)][docs-latest-img]][docs-latest-url]
 [![DOI][doi-img]][doi-url]
 [![Bors][bors-img]][bors-url]
@@ -11,8 +12,10 @@ KernelAbstractions.jl
 | 1.5     | [![CI][ci-img]][ci-url]                             | [![Build status][buildkite-julia1-img]][buildkite-julia1-url]             |
 | nightly | [![CI][ci-julia-nightly-img]][ci-julia-nightly-url] | [![Build status][buildkite-julianightly-img]][buildkite-julianightly-url] |
 
-[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
-[docs-latest-url]: https://juliagpu.gitlab.io/KernelAbstractions.jl/
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://juliagpu.github.io/KernelAbstractions.jl/stable
+[docs-latest-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-latest-url]: https://juliagpu.github.io/KernelAbstractions.jl/dev
 [doi-img]: https://zenodo.org/badge/237471203.svg
 [doi-url]: https://zenodo.org/badge/latestdoi/237471203
 [bors-img]: https://bors.tech/images/badge_small.svg
@@ -29,4 +32,4 @@ KernelAbstractions.jl
 License
 -------
 
-KernelAbstractions.jl is licensed under [MIT license](LICENSE.md).
+KernelAbstractions.jl is licensed under the [MIT license](LICENSE.md).

docs/make.jl

@@ -1,25 +1,33 @@
-using Documenter, KernelAbstractions
+using KernelAbstractions
+using Documenter
 
-makedocs(
-    modules = [KernelAbstractions],
-    sitename = "KernelAbstractions",
-    format = Documenter.HTML(
-        prettyurls = get(ENV, "CI", nothing) == "true"
+makedocs(;
+    modules=[KernelAbstractions],
+    authors="JuliaGPU and contributors",
+    repo="https://github.com/JuliaGPU/KernelAbstractions.jl/blob/{commit}{path}#L{line}",
+    sitename="KernelAbstractions.jl",
+    format=Documenter.HTML(;
+        prettyurls=get(ENV, "CI", "false") == "true",
+        canonical="https://juliagpu.github.io/KernelAbstractions.jl",
+        assets=String[],
     ),
-    pages = [
+    pages=[
         "Home" => "index.md",
         "Writing kernels" => "kernels.md",
         "Examples" => [
-            "examples/memcopy.md"
-            "examples/memcopy_static.md"
-            "examples/naive_transpose.md"
-            "examples/performance.md"
-            "examples/matmul.md"
-        ],
-        "API"          => "api.md",
+            "examples/memcopy.md",
+            "examples/memcopy_static.md",
+            "examples/naive_transpose.md",
+            "examples/performance.md",
+            "examples/matmul.md",
+        ], # Examples
+        "API" => "api.md",
         "Extras" => [
-            "extras/unrolling.md"
-        ]
-    ],
-    doctest = true
+            "extras/unrolling.md",
+        ], # Extras
+    ], # pages
+)
+
+deploydocs(;
+    repo="github.com/JuliaGPU/KernelAbstractions.jl",
 )