Skip to content

Commit

Permalink
Fix documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
maleadt committed Dec 11, 2018
1 parent 7aad5c3 commit 39e7783
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 53 deletions.
11 changes: 0 additions & 11 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -25,12 +20,6 @@ test:dev:
- staging
- trying

documentation:
only:
- master
- staging
- trying

coverage:
only:
- master
Expand Down
14 changes: 11 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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?
Expand Down
3 changes: 0 additions & 3 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "~0.19"
17 changes: 10 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -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"
)
24 changes: 0 additions & 24 deletions docs/mkdocs.yml

This file was deleted.

0 comments on commit 39e7783

Please sign in to comment.