Skip to content

Commit c3bc390

Browse files
configure documenter
1 parent 6bb140e commit c3bc390

File tree

5 files changed

+43
-0
lines changed

5 files changed

+43
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
deps/usr
22
deps/deps.jl
33
*.log
4+
docs/build/
5+
docs/site/

.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
language: julia
2+
23
os:
34
- linux
5+
46
julia:
57
- nightly
68
- 1.0
9+
10+
after_success:
11+
- julia -e 'using Pkg; ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
12+
- julia -e 'using Pkg; cd(Pkg.dir("SuiteSparseGraphBLAS")); include(joinpath("docs", "make.jl"))'

docs/make.jl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using Documenter, SuiteSparseGraphBLAS
2+
3+
makedocs(
4+
modules = [SuiteSparseGraphBLAS],
5+
format = Documenter.HTML(),
6+
sitename = "GraphBLAS.jl",
7+
doctest = false,
8+
pages = Any[
9+
"Basic matrix functions" => "matrix_methods.md",
10+
"Basic vector functions" => "vector_methods.md"
11+
]
12+
)
13+
14+
deploydocs(
15+
julia = "nightly",
16+
repo = "github.com/abhinavmehndiratta/SuiteSparseGraphBLAS.jl.git"
17+
)

docs/src/matrix_methods.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Basic matrix functions
2+
3+
```@autodocs
4+
Modules = [SuiteSparseGraphBLAS]
5+
Pages = [
6+
"Object_Methods/Matrix_Methods.jl",
7+
]
8+
Private = false
9+
```

docs/src/vector_methods.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Basic vector functions
2+
3+
```@autodocs
4+
Modules = [SuiteSparseGraphBLAS]
5+
Pages = [
6+
"Object_Methods/Vector_Methods.jl",
7+
]
8+
Private = false
9+
```

0 commit comments

Comments
 (0)