Mercurial > repos > public > sbplib_julia

annotate docs/make.jl @ 837:126e169bb0b7 feature/setup_documenter

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial setup of Documenter.jl
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 14 Jan 2022 09:01:12 +0100
parents
children 23bce17a59cb
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
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 sitename = "Sbplib.jl"
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 prettyurls = false
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14 pages = [
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 "index.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16 "Submodules" => [
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
17 "submodules/grids.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18 "submodules/diff_ops.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 "submodules/lazy_tensors.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 "submodules/region_indices.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21 "submodules/sbp_operators.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 "submodules/static_dicts.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 ],
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
24 "doc_index.md",
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
25 ]
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26 # 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
27
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 format=Documenter.HTML(;prettyurls)
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 makedocs(;sitename, pages, format)
126e169bb0b7 Initial setup of Documenter.jl
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 # TBD: Should `prettyurls` be true or false when this is deployed to a webserver?