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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
#=* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* This file is part of the HiGHS linear optimization suite *
* *
* Written and engineered 2008-2024 by Julian Hall, Ivet Galabova, *
* Leona Gottwald and Michael Feldmeier *
* *
* Available as open-source under the MIT License *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *=#
import Pkg
Pkg.activate(@__DIR__)
Pkg.instantiate()
import Documenter
# ==============================================================================
# Parse and build docstrings from the C API
# ==============================================================================
const libhighs = ""
include(joinpath(@__DIR__, "c_api_gen", "build.jl"))
include(joinpath(@__DIR__, "c_api_gen", "libhighs.jl"))
# ==============================================================================
# Make the documentation
# ==============================================================================
Documenter.makedocs(
sitename = "HiGHS Documentation",
authors = "Julian Hall and Ivet Galabova",
format = Documenter.HTML(
# Use clean URLs, unless built as a "local" build
# prettyurls = !("local" in ARGS),
prettyurls = get(ENV, "CI", nothing) == "true",
highlights = ["yaml"],
),
strict = !("strict=false" in ARGS),
doctest = ("doctest=only" in ARGS) ? :only : true,
repo = "https://github.com/ERGO-Code/HiGHS/tree/latest{path}",
linkcheck = true,
linkcheck_ignore = [
"https://crates.io/crates/highs",
"https://crates.io/crates/good_lp",
"https://link.springer.com/article/10.1007/s12532-017-0130-5",
],
pages = [
"About" => "index.md",
"installation.md",
"Executable" => "executable.md",
"Guide" => Any[
"guide/index.md",
"guide/basic.md",
"guide/further.md",
"guide/advanced.md"
],
"Data structures" => Any[
"structures/index.md",
"structures/enums.md",
"Classes" => Any[
"structures/classes/index.md",
"structures/classes/HighsSparseMatrix.md",
"structures/classes/HighsLp.md",
"structures/classes/HighsHessian.md",
"structures/classes/HighsModel.md",
"structures/classes/HighsSolution.md",
"structures/classes/HighsBasis.md",
"structures/classes/HighsInfo.md",
],
],
"Callbacks" => "callbacks.md",
"Interfaces" => Any[
"C++" => Any[
"interfaces/cpp/index.md",
"The HiGHS library" => "interfaces/cpp/library.md",
"Examples" => "interfaces/cpp/examples.md",
],
"C" => "interfaces/c_api.md",
"Fortran" => "interfaces/fortran.md",
"Python" => Any[
"interfaces/python/index.md",
"interfaces/python/example-py.md",
],
"CSharp" => "interfaces/csharp.md",
"Julia" => "interfaces/julia/index.md",
"Other" => "interfaces/other.md",
],
"Options" => Any[
"options/intro.md",
"options/definitions.md"
],
"Parallel" => "parallel.md",
"Solvers" => "solvers.md",
"Terminology" => "terminology.md",
],
)
# ==============================================================================
# Deploy everything in `build`
# ==============================================================================
Documenter.deploydocs(;
repo = "github.com/ERGO-Code/HiGHS.git",
push_preview = true,
devbranch = "latest",
)
|
