QuantumESPRESSOBase.jl/docs/make.jl at 997b8abd747f115e8b42aaed77bd790f31e950f2 · MineralsCloud/QuantumESPRESSOBase.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 QuantumESPRESSOBase
using Documenter

DocMeta.setdocmeta!(
    QuantumESPRESSOBase,
    :DocTestSetup,
    :(using QuantumESPRESSOBase, QuantumESPRESSOBase.PWscf, QuantumESPRESSOBase.PHonon);
    recursive=true,
)

makedocs(;
    modules=[QuantumESPRESSOBase],
    authors="singularitti <singularitti@outlook.com> and contributors",
    sitename="QuantumESPRESSOBase.jl",
    format=Documenter.HTML(;
        canonical="https://MineralsCloud.github.io/QuantumESPRESSOBase.jl",
        edit_link="main",
        assets=String[],
    ),
    pages=[
        "Home" => "index.md",
        "Manual" => [
            "Installation Guide" => "man/installation.md",
            "Troubleshooting" => "man/troubleshooting.md",
        ],
        "Reference" => Any[
            "Public API" => "lib/public.md",
            "Internals" => map(
                s -> "lib/internals/$(s)",
                sort(readdir(joinpath(@__DIR__, "src/lib/internals"))),
            ),
        ],
        "Developer Docs" => [
            "Contributing" => "developers/contributing.md",
            "Style Guide" => "developers/style-guide.md",
            "Design Principles" => "developers/design-principles.md",
        ],
    ],
)

deploydocs(; repo="github.com/MineralsCloud/QuantumESPRESSOBase.jl", devbranch="main")