Skip to content

Commit 30e8c8f

Browse files
committed
add documenter
1 parent 5598067 commit 30e8c8f

File tree

5 files changed

+44
-0
lines changed

5 files changed

+44
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
*.jl.mem
44
/src/backends/supported_backends.jl
55
juliaset.png
6+
docs/build/
7+
docs/site/

.travis.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ matrix:
1212
- julia: nightly
1313
notifications:
1414
email: false
15+
after_success:
16+
- julia -e 'Pkg.add("Documenter")'
17+
- julia -e 'cd(Pkg.dir("GPUArrays")); include(joinpath("docs", "make.jl"))'

docs/make.jl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
using Documenter, GPUArrays
2+
3+
makedocs()
4+
5+
deploydocs(
6+
deps = Deps.pip("mkdocs", "python-markdown-math"),
7+
repo = "github.com/JuliaGPU/GPUArrays.jl.git",
8+
julia = "0.6",
9+
osname = "linux"
10+
)

docs/mkdocs.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
site_name: GPUArrays.jl
2+
repo_url: https://github.com/JuliaGPU/GPUArrays.jl
3+
site_description: Abstract GPU Array implementation
4+
site_author: JuliaGPU
5+
6+
theme: readthedocs
7+
8+
extra_css:
9+
- assets/Documenter.css
10+
11+
extra_javascript:
12+
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML
13+
- assets/mathjaxhelper.js
14+
15+
markdown_extensions:
16+
- extra
17+
- tables
18+
- fenced_code
19+
- mdx_math
20+
21+
docs_dir: 'build'
22+
23+
pages:
24+
- Home: index.md

docs/src/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GPUArrays Documentation
2+
3+
```@docs
4+
gpu_call(f, A::GPUArray, args::Tuple, configuration = length(A))
5+
```

0 commit comments

Comments
 (0)