Skip to content

Commit 4d1d8d9

Browse files
committed
docs kinda build (but 10000 doccheck fails)
1 parent 77a9dbf commit 4d1d8d9

File tree

10 files changed

+37
-136
lines changed

10 files changed

+37
-136
lines changed

docs/Project.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@ Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
1414
Tulip = "6dd1b50a-3aae-11e9-10b5-ef983d2400fa"
1515

1616
[compat]
17-
Documenter = "0.26"
18-
Literate = "2.8"
17+
Documenter = "1"
18+
Literate = "2"

docs/src/reference.md

Lines changed: 3 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,6 @@
11
# API reference
22

3-
## Helper types
4-
5-
```@autodocs
6-
Modules = [COBREXA]
7-
Pages = ["src/types.jl"]
8-
```
9-
10-
## Model loading and saving
11-
12-
```@autodocs
13-
Modules = [COBREXA]
14-
Pages = ["src/io.jl"]
15-
```
16-
17-
## Constraint system building
18-
19-
```@autodocs
20-
Modules = [COBREXA]
21-
Pages = ["src/builders/core.jl"]
22-
```
23-
24-
### Genetic constraints
25-
26-
```@autodocs
27-
Modules = [COBREXA]
28-
Pages = ["src/builders/genes.jl"]
3+
```@contents
4+
Pages = ["reference/types.md", "reference/io.md", "reference/builders.md", "reference/solver.md"]
5+
Depth = 2
296
```
30-
31-
### Objective function helpers
32-
33-
```@autodocs
34-
Modules = [COBREXA]
35-
Pages = ["src/builders/objectives.jl"]
36-
```
37-
38-
## Solver interface
39-
40-
```@autodocs
41-
Modules = [COBREXA]
42-
Pages = ["src/solver.jl"]
43-
```
44-
45-
## Analysis functions
46-
47-
## Distributed analysis

docs/src/reference/analysis.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/src/reference/base.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

docs/src/reference/builders.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
2+
## Constraint system building
3+
4+
```@autodocs
5+
Modules = [COBREXA]
6+
Pages = ["src/builders/core.jl"]
7+
```
8+
9+
### Genetic constraints
10+
11+
```@autodocs
12+
Modules = [COBREXA]
13+
Pages = ["src/builders/genes.jl"]
14+
```
15+
16+
### Objective function helpers
17+
18+
```@autodocs
19+
Modules = [COBREXA]
20+
Pages = ["src/builders/objectives.jl"]
21+
```

docs/src/reference/io.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
1-
# Input and output
21

3-
## File I/O and serialization
2+
# Model loading and saving
43

54
```@autodocs
65
Modules = [COBREXA]
7-
Pages = map(file -> joinpath("io", file), readdir("../src/io"))
8-
```
9-
10-
## Pretty printing
11-
12-
```@autodocs
13-
Modules = [COBREXA]
14-
Pages = map(file -> joinpath("io", "show", file), readdir("../src/io/show"))
6+
Pages = ["src/io.jl"]
157
```

docs/src/reference/reconstruction.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/src/reference/solver.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
# Solver interface
3+
4+
```@autodocs
5+
Modules = [COBREXA]
6+
Pages = ["src/solver.jl"]
7+
```

docs/src/reference/types.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,7 @@
1-
# Types
21

3-
## Base types
2+
# Helper types
43

54
```@autodocs
65
Modules = [COBREXA]
7-
Pages = map(file -> joinpath("base", "types", "abstract", file), readdir("../src/base/types/abstract"))
8-
```
9-
10-
## Model types and contents
11-
```@autodocs
12-
Modules = [COBREXA]
13-
Pages = map(file -> joinpath("base", "types", file), readdir("../src/base/types"))
14-
```
15-
16-
## Model type wrappers
17-
```@autodocs
18-
Modules = [COBREXA]
19-
Pages = map(file -> joinpath("base", "types", "wrappers", file), readdir("../src/base/types/wrappers"))
6+
Pages = ["src/types.jl"]
207
```

docs/src/reference/utils.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)