BackgroundMeshes.jl/docs/make.jl at 12cbc8ec2d69e2d08b17ceba9073933ae7e9c3c2 · JuliaAstro/BackgroundMeshes.jl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
using BackgroundMeshes
using Documenter
using Documenter.Remotes: GitHub

setup = quote
    using BackgroundMeshes
    using StableRNGs
    rng = StableRNG(1)
end

DocMeta.setdocmeta!(BackgroundMeshes, :DocTestSetup, setup; recursive=true)

pages = [
    "Home" => "index.md",
    "Examples" => ["examples/1_basics.md", "examples/2_background_estimation.md"],
    "API/Reference" => "api.md",
]

makedocs(;
    modules = [BackgroundMeshes],
    authors = "Miles Lucas <mdlucas@hawaii.edu> and contributors",
    repo = GitHub("JuliaAstro/BackgroundMeshes.jl"),
    sitename = "BackgroundMeshes.jl",
    format = Documenter.HTML(;
        prettyurls = true,
        canonical = "https://JuliaAstro.github.io/BackgroundMeshes.jl",
        edit_link = "main",
    ),
    pages,
    checkdocs = :exports,
)

# CI only: deploy docs
in_CI_env = get(ENV, "CI", "false") == "true"
if in_CI_env
    deploydocs(;
        repo = "github.com/JuliaAstro/BackgroundMeshes.jl",
        push_preview = true,
        devbranch = "main",
    )
end