ModelPredictiveControl.jl/docs/make.jl at 141d162ff9818b2f88ba2ccb13c530019cc54d12 · JuliaControl/ModelPredictiveControl.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
# debug bad cropping Plots in manual:
ENV["PLOTS_TEST"] = "true"
ENV["GKSwstype"] = "nul"
push!(LOAD_PATH,"../src/")

using Documenter, DocumenterInterLinks
using ModelPredictiveControl
import LinearMPC

links = InterLinks(
    "Julia" => "https://docs.julialang.org/en/v1/objects.inv",
    "ControlSystemsBase" => "https://juliacontrol.github.io/ControlSystems.jl/stable/objects.inv",
    "JuMP" => "https://jump.dev/JuMP.jl/stable/objects.inv",
    "MathOptInterface" => "https://jump.dev/MathOptInterface.jl/stable/objects.inv",
    "DifferentiationInterface" => "https://juliadiff.org/DifferentiationInterface.jl/DifferentiationInterface/stable/objects.inv",
    "ForwardDiff" => "https://juliadiff.org/ForwardDiff.jl/stable/objects.inv",
    "LowLevelParticleFilters" => "https://baggepinnen.github.io/LowLevelParticleFilters.jl/stable/objects.inv",
    "LinearMPC" => "https://darnstrom.github.io/LinearMPC.jl/stable/objects.inv",
)

DocMeta.setdocmeta!(
    ModelPredictiveControl,
    :DocTestSetup,
    :(using ModelPredictiveControl, ControlSystemsBase);
    recursive=true
)
makedocs(
    sitename    = "ModelPredictiveControl.jl",
    #format = Documenter.LaTeX(platform = "none"),
    doctest     = true,
    plugins     = [links],
    format      = Documenter.HTML(
        prettyurls = get(ENV, "CI", nothing) == "true",
        edit_link = "main"
    ),
    pages = [
        "Home" => "index.md",
        "Manual" => [
            "Installation" => "manual/installation.md",
            "Examples" => [
                "Linear Design" => "manual/linmpc.md",
                "Nonlinear Design" => "manual/nonlinmpc.md",
                "ModelingToolkit" =>  "manual/mtk.md",
            ],
        ],
        "Functions" => [
            "Public" => [
                "Plant Models" => "public/sim_model.md",
                "State Estimators" => "public/state_estim.md",
                "Predictive Controllers" => "public/predictive_control.md",
                "Generic Functions" => "public/generic_func.md",
                "Simulations and Plots" => "public/plot_sim.md",
            ],
            "Internals" => [
                "Plant Models" => "internals/sim_model.md",
                "State Estimators" => "internals/state_estim.md",
                "Predictive Controllers" => "internals/predictive_control.md",
            ],
        ],
        "Index" => "func_index.md"
    ]
)

deploydocs(
    repo = "github.com/JuliaControl/ModelPredictiveControl.jl.git",
    devbranch = "main",
    push_preview = true
)