Skip to content

Commit ff13eef

Browse files
committed
fixing checks in the docs
1 parent 9165f0c commit ff13eef

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

docs/make.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ makedocs(
1818
canonical = "https://docs.sciml.ai/StructuralIdentifiability/stable/",
1919
),
2020
pages = pages,
21-
checkdocs = :none,
21+
checkdocs = :exports,
2222
)
2323

2424
deploydocs(repo = "github.com/SciML/StructuralIdentifiability.jl.git"; push_preview = true)

docs/pages.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pages = [
1010
"Local Identifiability Tools" => "utils/local_identifiability.md",
1111
"Global Identifiability Tools" => "utils/global_identifiability.md",
1212
"Elimination" => "utils/elimination.md",
13-
# "ODE Tools" => "utils/ode.md",
13+
"ODE Tools" => "utils/ode.md",
1414
"Power Series Tools" => "utils/power_series_utils.md",
1515
"Primality Checks" => "utils/primality.md",
1616
"Wronskian Tools" => "utils/wronskian.md",

docs/src/utils/ode.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Functions to work with the ODE structure
2+
3+
```@autodocs
4+
Modules = [StructuralIdentifiability]
5+
Pages = ["ODE.jl", "submodels.jl"]
6+
Order = [:function]
7+
```

src/ODE.jl

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# P is the type of polynomials in the rhs of the ODE system
21
"""
32
The main structure that represents input ODE system.
43
54
Stores information about states (`x_vars`), outputs (`y_vars`), inputs (`u_vars`), parameters (`parameters`) and the equations.
65
76
This structure is constructed via `@ODEmodel` macro.
87
"""
9-
struct ODE{P}
8+
struct ODE{P} # P is the type of polynomials in the rhs of the ODE system
109
poly_ring::MPolyRing
1110
x_vars::Array{P, 1}
1211
y_vars::Array{P, 1}

0 commit comments

Comments
 (0)