Mercurial > repos > public > sbplib_julia

annotate docs/make.jl @ 841:23bce17a59cb feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implement flag to controll pretty urls
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 09:59:41 +0100
parents 126e169bb0b7
children b4f542b4f2e4
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
837
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 pages = [
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 "index.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 "Submodules" => [
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 "submodules/grids.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 "submodules/diff_ops.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
24 "submodules/lazy_tensors.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
25 "submodules/region_indices.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26 "submodules/sbp_operators.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
27 "submodules/static_dicts.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 ],
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 "doc_index.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 ]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31 # 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
32
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33 format=Documenter.HTML(;prettyurls)
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 makedocs(;sitename, pages, format)