AlgorithmsInterface.jl/docs/make.jl at 042a3690d2cd1704e7d2e47570cea6bff2b0ecf5 · JuliaManifolds/AlgorithmsInterface.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
#!/usr/bin/env julia
#
#

if "--help" ∈ ARGS
    println(
        """
        docs/make.jl

        Render the `AlgorithmsInterface.jl` documentation with optional arguments

        Arguments
        * `--help`              print this help and exit without rendering the documentation
        * `--prettyurls`        toggle the pretty urls part to true, which is always set on CI
        """
    )
    exit(0)
end

using Pkg
Pkg.activate(@__DIR__)
Pkg.develop(PackageSpec(; path = (@__DIR__) * "/../"))
Pkg.resolve()
Pkg.instantiate()

using Documenter, DocumenterCitations, DocumenterInterLinks
using AlgorithmsInterface

run_on_CI = (get(ENV, "CI", nothing) == "true")

bib = CitationBibliography(joinpath(@__DIR__, "src", "references.bib"); style = :alpha)
links = InterLinks()
makedocs(;
    format = Documenter.HTML(;
        prettyurls = run_on_CI || ("--prettyurls" ∈ ARGS),
        assets = [
            #    "assets/favicon.ico",
            "assets/citations.css",
            "assets/link-icons.css",
        ],
    ),
    modules = [AlgorithmsInterface],
    authors = "Ronny Bergmann, Lukas Devos, and contributors.",
    sitename = "AlgorithmsInterface.jl",
    pages = [
        "Home" => "index.md",
        "Interface" => "interface.md",
        "Stopping criteria" => "stopping_criterion.md",
        "Logging" => "logging.md",
        "Notation" => "notation.md",
        "References" => "references.md",
    ],
    expandfirst = ["interface.md", "stopping_criterion.md"],
    plugins = [bib, links],
)
deploydocs(; repo = "github.com/JuliaManifolds/AlgorithmsInterface.jl", push_preview = true)
#back to main env
Pkg.activate()