Skip to content

Commit 1b233ce

Browse files
setup Documenter.jl
1 parent bdc79de commit 1b233ce

File tree

3 files changed

+38
-1
lines changed

3 files changed

+38
-1
lines changed

.travis.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,14 @@ notifications:
1616

1717
coveralls: true
1818
codecov: true
19+
20+
jobs:
21+
include:
22+
- stage: "Documentation"
23+
julia: 1.4
24+
os: linux
25+
script:
26+
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
27+
Pkg.instantiate()'
28+
- julia --project=docs/ docs/make.jl
29+
after_success: skip

docs/Project.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[deps]
2+
ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
3+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
4+
5+
[compat]
6+
Documenter = "0.24.2"

docs/make.jl

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,29 @@ using Documenter, ModelingToolkit
22

33
makedocs(
44
sitename="ModelingToolkit.jl",
5+
authors="Chris Rackauckas",
56
modules=[ModelingToolkit],
7+
clean=true,
8+
format = Documenter.HTML(#analytics = "UA-90474609-3",
9+
assets = ["assets/favicon.ico"],
10+
canonical="https://docs.sciml.ai/stable/"),
611
pages=[
712
"Home" => "index.md",
8-
"api.md",
13+
"highlevel.md",
14+
"tracing.md",
15+
"Systems" => Any[
16+
"systems/AbstractSystem.md",
17+
"systems/ODESystem.md",
18+
"systems/SDESystem.md",
19+
"systems/NonlinearSystem.md",
20+
"systems/OptimizationSystem.md",
21+
"systems/ReactionSystem.md",
22+
"systems/PDESystem.md"
23+
],
24+
"IR.md"
925
]
1026
)
27+
28+
deploydocs(
29+
repo = "github.com/SciML/ModelingToolkit.jl.git"
30+
)

0 commit comments

Comments
 (0)