Skip to content

Commit 2030591

Browse files
committed
Fix docs.
1 parent a03cb26 commit 2030591

File tree

5 files changed

+119
-3
lines changed

5 files changed

+119
-3
lines changed

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
[deps]
22
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
DocumenterInterLinks = "d12716ef-a0f6-4df4-a9f1-a5a34e75c656"
4+
GeometricEquations = "c85262ba-a08a-430a-b926-d29770767bf2"
35
GeometricIntegratorsBase = "71212ab4-08a2-48eb-a02b-4cbad0e9c44a"
6+
GeometricSolutions = "7843afe4-64f4-4df4-9231-049495c56661"
47

58
[sources]
69
GeometricIntegratorsBase = {path = ".."}

docs/make.jl

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,37 @@
1-
using GeometricIntegratorsBase
21
using Documenter
2+
using DocumenterInterLinks
3+
using GeometricIntegratorsBase
4+
using GeometricEquations
5+
using GeometricSolutions
36

47
DocMeta.setdocmeta!(GeometricIntegratorsBase, :DocTestSetup, :(using GeometricIntegratorsBase); recursive=true)
58

9+
links = InterLinks(
10+
"GeometricEquations" => "https://JuliaGNI.github.io/GeometricEquations.jl/stable/",
11+
)
12+
613
makedocs(;
7-
modules=[GeometricIntegratorsBase],
8-
authors="Michael Kraus <[email protected]> and contributors",
914
sitename="GeometricIntegratorsBase.jl",
15+
plugins = [links,],
16+
warnonly = Documenter.except(:autodocs_block, :cross_references, :docs_block, :doctest, :eval_block, :example_block, :footnote, :linkcheck_remotes, :linkcheck, :meta_block, :parse_error, :setup_block),
17+
authors="Michael Kraus <[email protected]> and contributors",
1018
format=Documenter.HTML(;
1119
canonical="https://JuliaGNI.github.io/GeometricIntegratorsBase.jl",
1220
edit_link="main",
1321
assets=String[],
1422
),
1523
pages=[
1624
"Home" => "index.md",
25+
"Dependencies" => [
26+
"Equations" => "deps/equations.md",
27+
"Problems" => "deps/problems.md",
28+
"Solutions" => "deps/solutions.md",
29+
],
30+
],
31+
modules = [
32+
GeometricIntegratorsBase,
33+
GeometricEquations,
34+
GeometricSolutions,
1735
],
1836
)
1937

docs/src/deps/equations.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Equations
2+
3+
The following data structures are all implemented in [GeometricEquations.jl](https://github.com/JuliaGNI/GeometricEquations.jl).
4+
5+
```@docs
6+
GeometricEquations.GeometricEquation
7+
```
8+
9+
## Ordinary Differential Equations
10+
11+
```@docs
12+
GeometricEquations.ODE
13+
GeometricEquations.PODE
14+
GeometricEquations.HODE
15+
GeometricEquations.IODE
16+
GeometricEquations.LODE
17+
GeometricEquations.SODE
18+
```
19+
20+
## Differential Algebraic Equations
21+
22+
```@docs
23+
GeometricEquations.DAE
24+
GeometricEquations.PDAE
25+
GeometricEquations.HDAE
26+
GeometricEquations.IDAE
27+
GeometricEquations.LDAE
28+
```
29+
30+
## Stochastic Differential Equations
31+
32+
```@docs
33+
GeometricEquations.SDE
34+
GeometricEquations.PSDE
35+
GeometricEquations.SPSDE
36+
```
37+
38+
## Discrete Equations
39+
40+
```@docs
41+
GeometricEquations.DELE
42+
```

docs/src/deps/problems.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Problem Types
2+
3+
The following data structures are all implemented in [GeometricEquations.jl](https://github.com/JuliaGNI/GeometricEquations.jl).
4+
Each problem type is derived from [`EquationProblem`](@ref).
5+
6+
## Geometric Equation Problems
7+
8+
```@docs
9+
GeometricEquations.GeometricProblem
10+
GeometricEquations.EquationProblem
11+
GeometricEquations.EnsembleProblem
12+
```
13+
14+
## Ordinary Differential Equations
15+
16+
```@docs
17+
GeometricEquations.ODEProblem
18+
GeometricEquations.PODEProblem
19+
GeometricEquations.HODEProblem
20+
GeometricEquations.IODEProblem
21+
GeometricEquations.LODEProblem
22+
GeometricEquations.SODEProblem
23+
```
24+
25+
## Differential Algebraic Equations
26+
27+
```@docs
28+
GeometricEquations.DAEProblem
29+
GeometricEquations.PDAEProblem
30+
GeometricEquations.HDAEProblem
31+
GeometricEquations.IDAEProblem
32+
GeometricEquations.LDAEProblem
33+
```
34+
35+
## Stochastic Differential Equations
36+
37+
```@docs
38+
GeometricEquations.SDEProblem
39+
GeometricEquations.PSDEProblem
40+
GeometricEquations.SPSDEProblem
41+
```
42+
43+
## Discrete Equations
44+
45+
```@docs
46+
GeometricEquations.DELEProblem
47+
```

docs/src/deps/solutions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Solutions
2+
3+
```@autodocs
4+
Modules = [GeometricSolutions]
5+
Order = [:constant, :type, :macro, :function]
6+
```

0 commit comments

Comments
 (0)