Mercurial > repos > public > sbplib_julia
comparison docs/make.jl @ 837:126e169bb0b7 feature/setup_documenter
Initial setup of Documenter.jl
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Fri, 14 Jan 2022 09:01:12 +0100 |
parents | |
children | 23bce17a59cb |
comparison
equal
deleted
inserted
replaced
823:3c1dd7692797 | 837:126e169bb0b7 |
---|---|
1 using Documenter | |
2 using Sbplib | |
3 | |
4 using Sbplib.DiffOps | |
5 using Sbplib.Grids | |
6 using Sbplib.LazyTensors | |
7 using Sbplib.RegionIndices | |
8 using Sbplib.SbpOperators | |
9 using Sbplib.StaticDicts | |
10 | |
11 | |
12 sitename = "Sbplib.jl" | |
13 prettyurls = false | |
14 pages = [ | |
15 "index.md", | |
16 "Submodules" => [ | |
17 "submodules/grids.md", | |
18 "submodules/diff_ops.md", | |
19 "submodules/lazy_tensors.md", | |
20 "submodules/region_indices.md", | |
21 "submodules/sbp_operators.md", | |
22 "submodules/static_dicts.md", | |
23 ], | |
24 "doc_index.md", | |
25 ] | |
26 # This ordering is not respected by @contents. See https://github.com/JuliaDocs/Documenter.jl/issues/936 | |
27 | |
28 format=Documenter.HTML(;prettyurls) | |
29 makedocs(;sitename, pages, format) | |
30 # TBD: Should `prettyurls` be true or false when this is deployed to a webserver? |