Skip to content

Commit 721f04c

Browse files
committed
begin the quest for documentation
1 parent 85243f0 commit 721f04c

File tree

5 files changed

+451
-2
lines changed

5 files changed

+451
-2
lines changed

.travis.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ julia:
77
- 1.0
88
- nightly
99
matrix:
10-
# allow_failures:
11-
# - julia: nightly
10+
allow_failures:
11+
- julia: nightly
1212
notifications:
1313
email: false
1414
before_install:
1515
- if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
1616
after_success:
1717
- julia -e 'cd(Pkg.dir("DistributedArrays")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder()); Codecov.submit(Codecov.process_folder())'
18+
- julia -e 'cd(Pkg.dir("DistributedArrays")); Pkg.add("Documenter"); include(joinpath("docs", "make.jl"))'

docs/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build/

docs/make.jl

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
using Documenter, DistributedArrays
2+
3+
makedocs(
4+
modules = [DistributedArrays],
5+
format = :html,
6+
sitename = "DistributedArrays.jl",
7+
pages = [
8+
"Introduction" => "index.md"
9+
"API" => "api.md"
10+
],
11+
doctest = true
12+
)
13+
14+
deploydocs(
15+
repo = "github.com/JuliaParallel/DistributedArrays.jl.git",
16+
julia = "1.0",
17+
# no need to build anything here, re-use output of `makedocs`
18+
target = "build",
19+
deps = nothing,
20+
make = nothing
21+
)

docs/src/api.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API
2+
3+
```@autodocs
4+
Modules = [DistributedArrays]
5+
```

0 commit comments

Comments
 (0)