Mercurial > repos > public > sbplib_julia

annotate docs/make.jl @ 1715:0f655c1b7dba update/julia_1.10.5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Closing branch before merge to default
author Vidar Stiernström <vidar.stiernstrom@gmail.com>
date Thu, 05 Sep 2024 08:22:22 -0700
parents 7753fa972c74
children 40dffe6e2ecb
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
1489
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
13 remotes = nothing
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
14 edit_link = nothing
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
15 repolink = nothing
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
16
841
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
17 if "--prettyurls" ∈ ARGS
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
18 prettyurls = true
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
19 else
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
20 prettyurls = false
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
21 end
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
22
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
23 if "--build-dir" ∈ ARGS
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
24 i = findlast(==("--build-dir"), ARGS)
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
25 build = ARGS[i+1]
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
26 else
849
9ab2651ea00b Better default build location
Jonatan Werpers <jonatan@werpers.com>
parents: 845
diff changeset
27 build = "build-local"
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
28 end
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
29
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 pages = [
851
0ef00e1426b1 Change name of top page in sidebar
Jonatan Werpers <jonatan@werpers.com>
parents: 849
diff changeset
31 "Home" => "index.md",
852
510f744d0876 Add some documentation for the file format
Jonatan Werpers <jonatan@werpers.com>
parents: 849
diff changeset
32 "operator_file_format.md",
1341
5761f4060f2b Start adding general info about grids to docs
Jonatan Werpers <jonatan@werpers.com>
parents: 859
diff changeset
33 "grids_and_grid_functions.md",
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 "Submodules" => [
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35 "submodules/grids.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36 "submodules/diff_ops.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37 "submodules/lazy_tensors.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 "submodules/region_indices.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 "submodules/sbp_operators.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
40 "submodules/static_dicts.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
41 ],
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
42 "doc_index.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
43 ]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
44 # 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
45
1489
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
46 format=Documenter.HTML(;prettyurls, edit_link, repolink)
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
47
7753fa972c74 Update docs manifest to julia 1.10 and fix issues in make docs
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1341
diff changeset
48 makedocs(;sitename, pages, format, build, remotes)