Skip to content

Commit e98ef1e

Browse files
Modify docs structure
1 parent 345fa47 commit e98ef1e

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

docs/make.jl

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,37 @@ using ClimaTimeSteppers
44
bib = CitationBibliography(joinpath(@__DIR__, "refs.bib"))
55

66

7+
#! format: off
8+
pages = [
9+
"index.md",
10+
"Algorithm formulations" => [
11+
"algo_formulations/lsrk.md",
12+
"algo_formulations/ssprk.md",
13+
"algo_formulations/ark.md",
14+
"algo_formulations/mrrk.md",
15+
],
16+
"Non-linear solvers" => [
17+
"Formulation" => "nl_solvers/formulation.md",
18+
"Newtons method" => "nl_solvers/newtons_method.md",
19+
],
20+
"Test problems" => [
21+
"index.md",
22+
],
23+
"API docs" => [
24+
"Algorithms" => "api/algorithms.md",
25+
"Tableaus" => "api/tableaus.md",
26+
"Non-linear solvers" => "api/nl_solvers.md",
27+
"Callbacks" => "api/callbacks.md",
28+
],
29+
"Algorithm comparisons" => "algo_comparisons.md",
30+
"Developer docs" => [
31+
"Types" => "dev/types.md",
32+
"Report generator" => "dev/report_gen.md",
33+
],
34+
"references.md",
35+
]
36+
#! format: on
37+
738
makedocs(
839
bib,
940
sitename = "ClimaTimeSteppers",
@@ -12,16 +43,7 @@ makedocs(
1243
checkdocs = :exports,
1344
clean = true,
1445
strict = true,
15-
pages = [
16-
"index.md",
17-
"algorithms.md",
18-
"newtons_method.md",
19-
"callbacks.md",
20-
"Background" => ["background/lsrk.md", "background/ssprk.md", "background/ark.md", "background/mrrk.md"],
21-
"test_problems.md",
22-
"algo_comparisons.md",
23-
"references.md",
24-
],
46+
pages = pages,
2547
)
2648

2749
# Documenter can also automatically deploy documentation to gh-pages.

0 commit comments

Comments
 (0)