Skip to content

Commit 073824b

Browse files
add object methods to documentation
1 parent 640ff17 commit 073824b

File tree

5 files changed

+36
-6
lines changed

5 files changed

+36
-6
lines changed

docs/make.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@ makedocs(
77
doctest = false,
88
pages = Any[
99
"Introduction" => "index.md",
10-
"Basic matrix functions" => "matrix_methods.md",
11-
"Basic vector functions" => "vector_methods.md"
10+
"Basic matrix & vector methods" => "matrix_and_vector_methods.md",
11+
"Operators & algebraic structures" => "algebra_methods.md"
12+
"Descriptors" => "desc_methods.md",
13+
"Freeing objects" => "free_methods.md"
1214
]
1315
)
1416

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## Basic matrix functions
1+
## Algebra methods
22

33
```@autodocs
44
Modules = [SuiteSparseGraphBLAS]
55
Pages = [
6-
"Object_Methods/Matrix_Methods.jl",
6+
"Object_Methods/Algebra_Methods.jl",
77
]
88
Private = false
99
```
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
## Basic vector functions
1+
## Descriptor methods
22

33
```@autodocs
44
Modules = [SuiteSparseGraphBLAS]
55
Pages = [
6-
"Object_Methods/Vector_Methods.jl",
6+
"Object_Methods/Descriptor_Methods.jl",
77
]
88
Private = false
99
```

docs/src/free_methods.md

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

docs/src/matrix_and_vector_methods.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Matrix functions
2+
3+
```@autodocs
4+
Modules = [SuiteSparseGraphBLAS]
5+
Pages = [
6+
"Object_Methods/Matrix_Methods.jl",
7+
]
8+
Private = false
9+
```
10+
11+
## Vector functions
12+
13+
```@autodocs
14+
Modules = [SuiteSparseGraphBLAS]
15+
Pages = [
16+
"Object_Methods/Vector_Methods.jl",
17+
]
18+
Private = false
19+
```

0 commit comments

Comments
 (0)