Skip to content

Commit 9d271bf

Browse files
authored
Merge pull request #875 from SciML/obscure_doc_error_fix
Skip bits that yield weird documenter errors
2 parents 3abba83 + 73b1e58 commit 9d271bf

File tree

5 files changed

+12
-45
lines changed

5 files changed

+12
-45
lines changed

docs/make.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ makedocs(sitename = "Catalyst.jl",
3939
modules = [Catalyst, ModelingToolkit],
4040
doctest = false,
4141
clean = true,
42-
pages = pages)
42+
pages = pages,
43+
pagesonly = true,
44+
warnonly = true)
4345

4446
deploydocs(repo = "github.com/SciML/Catalyst.jl.git";
4547
push_preview = true)

docs/src/home.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -174,39 +174,4 @@ versioninfo() # hide
174174
```
175175
```@raw html
176176
</details>
177-
```
178-
```@raw html
179-
<details><summary>A more complete overview of all dependencies and their versions is also provided.</summary>
180-
```
181-
```@example
182-
using Pkg # hide
183-
Pkg.status(; mode = PKGMODE_MANIFEST) # hide
184-
```
185-
```@raw html
186-
</details>
187-
```
188-
```@raw html
189-
You can also download the
190-
<a href="
191-
```
192-
```@eval
193-
using TOML
194-
projtoml = joinpath("..", "..", "Project.toml")
195-
version = TOML.parse(read(projtoml, String))["version"]
196-
name = TOML.parse(read(projtoml, String))["name"]
197-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * "/assets/Manifest.toml"
198-
```
199-
```@raw html
200-
">manifest</a> file and the
201-
<a href="
202-
```
203-
```@eval
204-
using TOML
205-
projtoml = joinpath("..", "..", "Project.toml")
206-
version = TOML.parse(read(projtoml, String))["version"]
207-
name = TOML.parse(read(projtoml, String))["name"]
208-
link = "https://github.com/SciML/" * name * ".jl/tree/gh-pages/v" * version * "/assets/Project.toml"
209-
```
210-
```@raw html
211-
">project</a> file.
212-
```
177+
```

docs/src/model_creation/chemistry_related_functionality.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,11 +144,11 @@ It is possible to balance all the reactions of a reaction system simultaneously
144144
rs = @reaction_network begin
145145
@species C(t) O(t) H(t)
146146
@compounds begin
147-
H2(t) = 2H
148-
CH4(t) = C + 4H
149-
O2(t) = 2O
150-
CO2(t) = C + 2O
151-
H2O(t) = 2H + O
147+
H2(t) ~ 2H
148+
CH4(t) ~ C + 4H
149+
O2(t) ~ 2O
150+
CO2(t) ~ C + 2O
151+
H2O(t) ~ 2H + O
152152
end
153153
1.0, C + H2 --> CH4
154154
2.0, CH4 + O2 --> CO2 + H2O

docs/src/model_creation/compositional_modeling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ To see all the species, parameters and reactions in the tree we can use
103103
species(rn) # or unknowns(rn)
104104
```
105105
```@example ex1
106-
parameters(rn) # or reactionparameters(rn)
106+
parameters(rn)
107107
```
108108
```@example ex1
109109
reactions(rn) # or equations(rn)

docs/src/steady_state_functionality/steady_state_stability_computation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ ss_jac = steady_state_jac(sa_loop)
5151
5252
ps_1 = [:v => 2.0, :K => 0.5, :n => 3, :d => 1.0]
5353
steady_states_1 = hc_steady_states(sa_loop, ps)
54-
stability_1 = steady_state_stability(steady_states_1, sa_loop, ps_1; ss_jac=ss_jac)
54+
stability_1 = [steady_state_stability(state, sa_loop, ps_1; ss_jac = ss_jac) for state in steady_states_1]
5555
5656
ps_2 = [:v => 4.0, :K => 1.5, :n => 2, :d => 1.0]
5757
steady_states_2 = hc_steady_states(sa_loop, ps)
58-
stability_2 = steady_state_stability(steady_states_2, sa_loop, ps_2; ss_jac=ss_jac)
58+
stability_2 = [steady_state_stability(state, sa_loop, ps_2; ss_jac = ss_jac) for state in steady_states_2]
5959
nothing # hide
6060
```
6161

0 commit comments

Comments
 (0)