Mercurial > repos > public > sbplib_julia

annotate docs/make.jl @ 1996:d89f7a1a6f37 feature/grids/manifolds

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add some notation to the docs page
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 23 Apr 2025 09:02:20 +0200
parents 3694f11075c5
children
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
1726
471a948cd2b2 Rename project from Sbplib to Diffinitive
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1709
diff changeset
2 using Diffinitive
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
1726
471a948cd2b2 Rename project from Sbplib to Diffinitive
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1709
diff changeset
4 using Diffinitive.Grids
471a948cd2b2 Rename project from Sbplib to Diffinitive
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1709
diff changeset
5 using Diffinitive.LazyTensors
471a948cd2b2 Rename project from Sbplib to Diffinitive
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1709
diff changeset
6 using Diffinitive.RegionIndices
471a948cd2b2 Rename project from Sbplib to Diffinitive
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1709
diff changeset
7 using Diffinitive.SbpOperators
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8
1726
471a948cd2b2 Rename project from Sbplib to Diffinitive
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1709
diff changeset
9 sitename = "Diffinitive.jl"
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
10
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
11 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
12 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
13 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
14
841
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
15 if "--prettyurls" ∈ ARGS
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
16 prettyurls = true
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
17 else
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
18 prettyurls = false
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
19 end
23bce17a59cb Implement flag to controll pretty urls
Jonatan Werpers <jonatan@werpers.com>
parents: 837
diff changeset
20
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
21 if "--build-dir" ∈ ARGS
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
22 i = findlast(==("--build-dir"), ARGS)
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
23 build = ARGS[i+1]
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
24 else
849
9ab2651ea00b Better default build location
Jonatan Werpers <jonatan@werpers.com>
parents: 845
diff changeset
25 build = "build-local"
845
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
26 end
b4f542b4f2e4 Use two folders for local and webserver builds
Jonatan Werpers <jonatan@werpers.com>
parents: 841
diff changeset
27
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 pages = [
851
0ef00e1426b1 Change name of top page in sidebar
Jonatan Werpers <jonatan@werpers.com>
parents: 849
diff changeset
29 "Home" => "index.md",
852
510f744d0876 Add some documentation for the file format
Jonatan Werpers <jonatan@werpers.com>
parents: 849
diff changeset
30 "operator_file_format.md",
1341
5761f4060f2b Start adding general info about grids to docs
Jonatan Werpers <jonatan@werpers.com>
parents: 859
diff changeset
31 "grids_and_grid_functions.md",
1709
40dffe6e2ecb Add docs page
Jonatan Werpers <jonatan@werpers.com>
parents: 1489
diff changeset
32 "matrix_and_tensor_representations.md",
1972
3694f11075c5 Review docs and Plots extension
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1922
diff changeset
33 "manifolds_charts_atlases.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/lazy_tensors.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37 "submodules/region_indices.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 "submodules/sbp_operators.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 ],
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
40 "doc_index.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 # 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
43
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
44 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
45
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 makedocs(;sitename, pages, format, build, remotes)