Mercurial > repos > public > sbplib_julia

annotate docs/make.jl @ 995:1ba8a398af9c refactor/lazy_tensors

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename types
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 18 Mar 2022 21:14:47 +0100
parents bdc718c38096
children 5761f4060f2b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 using Documenter
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 using Sbplib
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 using Sbplib.DiffOps
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 using Sbplib.Grids
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 using Sbplib.LazyTensors
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 using Sbplib.RegionIndices
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 using Sbplib.SbpOperators
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 using Sbplib.StaticDicts
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10
841
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
11 sitename = "Sbplib.jl"
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12
841
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
13 if "--prettyurls" ∈ ARGS
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
14 prettyurls = true
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
15 else
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
16 prettyurls = false
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
17 end
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
18
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
19 if "--build-dir" ∈ ARGS
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
20 i = findlast(==("--build-dir"), ARGS)
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
21 build = ARGS[i+1]
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
22 else
849
9ab2651ea00b Better default build location
Jonatan Werpers <jonatan@werpers.com>
parents: 845
diff changeset
23 build = "build-local"
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
24 end
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
25
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26 pages = [
851
0ef00e1426b1 Change name of top page in sidebar
Jonatan Werpers <jonatan@werpers.com>
parents: 849
diff changeset
27 "Home" => "index.md",
852
510f744d0876 Add some documentation for the file format
Jonatan Werpers <jonatan@werpers.com>
parents: 849
diff changeset
28 "operator_file_format.md",
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 "Submodules" => [
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 "submodules/grids.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31 "submodules/diff_ops.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 "submodules/lazy_tensors.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33 "submodules/region_indices.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 "submodules/sbp_operators.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35 "submodules/static_dicts.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36 ],
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37 "doc_index.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 ]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 # This ordering is not respected by @contents. See https://github.com/JuliaDocs/Documenter.jl/issues/936
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
40
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
41 format=Documenter.HTML(;prettyurls)
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
42 makedocs(;sitename, pages, format, build)