MatrixAlgebraKit.jl/docs/make.jl at 6beae739ecd2cb2dfa44a603b788490a4fb19734 · QuantumKitHub/MatrixAlgebraKit.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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# if examples is not the current active environment, switch to it
if Base.active_project() != joinpath(@__DIR__, "Project.toml")
    using Pkg
    Pkg.activate(@__DIR__)
    Pkg.develop(PackageSpec(; path = joinpath(@__DIR__, "..")))
    Pkg.resolve()
    Pkg.instantiate()
end

using MatrixAlgebraKit
using Documenter

plugins = []

# using DocumenterCitations
# bibpath = joinpath(@__DIR__, "src", "assets", "mpskit.bib")
# bib = CitationBibliography(bibpath; style=:authoryear)
# push!(plugins, bib)

# using DocumenterInterLinks
# links = InterLinks("TensorKit" => "https://jutho.github.io/TensorKit.jl/stable/",
#                    "TensorOperations" => "https://jutho.github.io/TensorOperations.jl/stable/",
#                    "KrylovKit" => "https://jutho.github.io/KrylovKit.jl/stable/",
#                    "BlockTensorKit" => "https://lkdvos.github.io/BlockTensorKit.jl/dev/")
# push!(plugins, links)

DocMeta.setdocmeta!(
    MatrixAlgebraKit, :DocTestSetup, :(using MatrixAlgebraKit);
    recursive = true
)

mathengine = MathJax3(
    Dict(
        :loader => Dict("load" => ["[tex]/physics"]),
        :tex => Dict(
            "inlineMath" => [["\$", "\$"], ["\\(", "\\)"]],
            "tags" => "ams",
            "packages" => ["base", "ams", "autoload", "physics"]
        )
    )
)
makedocs(;
    sitename = "MatrixAlgebraKit.jl",
    format = Documenter.HTML(;
        prettyurls = get(ENV, "CI", nothing) == "true",
        mathengine,
        size_threshold = 512000
    ),
    pages = [
        "Home" => "index.md",
        "User Interface" => [
            "user_interface/compositions.md",
            "user_interface/decompositions.md",
            "user_interface/algorithms.md",
            "user_interface/truncations.md",
            "user_interface/properties.md",
            "user_interface/matrix_functions.md",
        ],
        "Developer Interface" => "dev_interface.md",
        "Library" => "library.md",
        "Changelog" => "changelog.md",
    ],
    checkdocs = :exports,
    doctest = true,
    plugins
)

deploydocs(; repo = "github.com/QuantumKitHub/MatrixAlgebraKit.jl.git", push_preview = true)