Skip to content

Commit 39e7783

Browse files
committed
Fix documentation.
1 parent 7aad5c3 commit 39e7783

File tree

6 files changed

+34
-53
lines changed

6 files changed

+34
-53
lines changed

.gitlab-ci.yml

-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
variables:
22
CI_IMAGE_TAG: 'plain'
33

4-
stages:
5-
- test
6-
- postprocess
7-
84
include:
95
- 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/common.yml'
106
- 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/test_v1.0.yml'
117
- 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/test_dev.yml'
128
- 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v1/coverage_dev.yml'
13-
- 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/dev/documentation_v1.0.yml'
149

1510
test:v1.0:
1611
only:
@@ -25,12 +20,6 @@ test:dev:
2520
- staging
2621
- trying
2722

28-
documentation:
29-
only:
30-
- master
31-
- staging
32-
- trying
33-
3423
coverage:
3524
only:
3625
- master

.travis.yml

+11-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ branches:
2323
notifications:
2424
email: false
2525

26-
after_success:
27-
- julia -e 'ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
28-
- julia -e 'cd(Pkg.dir("GPUArrays")); include(joinpath("docs", "make.jl"))'
26+
jobs:
27+
include:
28+
- stage: "Documentation"
29+
julia: 1.0
30+
os: linux
31+
script:
32+
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
33+
Pkg.build();
34+
Pkg.instantiate()'
35+
- julia --project=docs/ docs/make.jl
36+
after_success: skip

README.md

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# GPUArrays
22

3-
[![](https://codecov.io/gh/JuliaGPU/GPUArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaGPU/GPUArrays.jl)
4-
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaGPU.github.io/GPUArrays.jl/latest)
3+
*Abstract GPU Array package for Julia's various GPU backends.*
4+
5+
[![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url]
6+
7+
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
8+
[docs-stable-url]: http://JuliaGPU.github.io/GPUArrays.jl/stable
9+
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
10+
[docs-dev-url]: http://JuliaGPU.github.io/GPUArrays.jl/dev
511

612

713
[Benchmarks](https://github.com/JuliaGPU/GPUBenchmarks.jl/blob/master/results/results.md)
814

9-
Abstract GPU Array package for Julia's various GPU backends.
10-
See it as a Julia Base.AbstractArray for GPUs.
11-
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.
15+
This package is the counterpart of Julia's `Base.AbstractArray` interface, but
16+
for GPU arary types. Currently, you either need to install
17+
[CLArrays](https://github.com/JuliaGPU/CLArrays.jl) or
18+
[CuArrays](https://github.com/JuliaGPU/CuArrays.jl) for a concrete
19+
implementation.
1220

1321

1422
# Why another GPU array package in yet another language?

docs/Project.toml

-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,2 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3-
4-
[compat]
5-
Documenter = "~0.19"

docs/make.jl

+10-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
using Documenter, GPUArrays
22

3-
makedocs()
3+
makedocs(
4+
modules = [GPUArrays],
5+
format = Documenter.HTML(),
6+
sitename = "GPUArrays.jl",
7+
pages = [
8+
"Home" => "index.md",
9+
],
10+
doctest = true
11+
)
412

513
deploydocs(
6-
repo = "github.com/JuliaGPU/GPUArrays.jl.git",
7-
julia = "0.7",
8-
osname = "linux",
9-
# no need to build anything here, re-use output of `makedocs`
10-
deps = nothing,
11-
make = nothing,
14+
repo = "github.com/JuliaGPU/GPUArrays.jl.git"
1215
)

docs/mkdocs.yml

-24
This file was deleted.

0 commit comments

Comments
 (0)