Skip to content

Commit dfeac45

Browse files
authored
[docs] set linkcheck=true during HTML build (#2098)
1 parent dc98b01 commit dfeac45

6 files changed

Lines changed: 11 additions & 9 deletions

File tree

docs/make.jl

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,10 @@ end
128128
mathengine = Documenter.MathJax2(),
129129
collapselevel = 1,
130130
),
131+
clean = true,
131132
strict = true,
133+
linkcheck = true,
134+
linkcheck_ignore = ["MathOptInterface.pdf"],
132135
modules = [MathOptInterface],
133136
checkdocs = :exports,
134137
doctest = _FIX ? :fix : true,

docs/src/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1156,7 +1156,7 @@ This release contains backports from the ongoing development of the v0.10 releas
11561156
- The `MOIU.@model` and `MOIB.@bridge` macros now support functions and sets
11571157
defined in external modules. As a consequence, function and set names in the
11581158
macro arguments need to be prefixed by module name.
1159-
- Rename functions according to the [JuMP style guide](http://www.juliaopt.org/JuMP.jl/latest/style.html):
1159+
- Rename functions according to the [JuMP style guide](https://jump.dev/JuMP.jl/stable/developers/style/):
11601160
* `copy!` with keyword arguments `copynames` and `warnattributes` ->
11611161
`copy_to` with keyword arguments `copy_names` and `warn_attributes`;
11621162
* `set!` -> `set`;

docs/src/manual/solutions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Mixed-integer programming solvers fall into this category.
110110
| `CPXMIP_OPTIMAL_INFEAS` | `ALMOST_OPTIMAL` | 1 | `INFEASIBLE_POINT` | `NO_SOLUTION` |
111111

112112
!!! info
113-
[`CPXMIP_OPTIMAL_INFEAS`](https://www.ibm.com/support/knowledgecenter/en/SSSA5P_12.6.1/ilog.odms.cplex.help/refcallablelibrary/macros/CPXMIP_OPTIMAL_INFEAS.html)
113+
[`CPXMIP_OPTIMAL_INFEAS`](https://www.ibm.com/docs/en/SSSA5P_12.6.1/ilog.odms.cplex.help/refcallablelibrary/macros/CPXMIP_OPTIMAL_INFEAS.html)
114114
is a CPLEX status that indicates that a preprocessed problem was solved to
115115
optimality, but the solver was unable to recover a feasible solution to the
116116
original problem. Handling this status was one of the motivating drivers

docs/src/submodules/Test/overview.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,7 @@ give the wrong answer.
206206

207207
**Step 1**
208208

209-
Install the `MathOptInterface` julia package in `dev` mode
210-
([ref](https://julialang.github.io/Pkg.jl/v1/managing-packages/#developing-1)):
209+
Install the `MathOptInterface` julia package in [`dev` mode](https://pkgdocs.julialang.org/v1/managing-packages/#developing-1):
211210
```julia
212211
julia> ]
213212
(@v1.6) pkg> dev MathOptInterface
@@ -222,7 +221,7 @@ machine).
222221
**Step 3**
223222

224223
Since the double-optimize error involves solving an optimization problem,
225-
add a new test to [src/Test/UnitTests/solve.jl](https://github.com/jump-dev/MathOptInterface.jl/blob/master/src/Test/UnitTests/solve.jl):
224+
add a new test to [src/Test/test_solve.jl](https://github.com/jump-dev/MathOptInterface.jl/blob/master/src/Test/test_solve.jl):
226225
```julia
227226
"""
228227
test_unit_optimize!_twice(model::MOI.ModelLike, config::Config)
@@ -309,4 +308,4 @@ submit the PR for review.
309308

310309
!!! tip
311310
If you need help writing a test, [open an issue on GitHub](https://github.com/jump-dev/MathOptInterface.jl/issues/new),
312-
or ask the [Developer Chatroom](https://gitter.im/JuliaOpt/JuMP.jl)
311+
or ask the [Developer Chatroom](https://app.gitter.im/#/room/#JuliaOpt_JuMP-dev:gitter.im)

docs/src/tutorials/mathprogbase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ as a modeling interface instead.
2020

2121
!!! tip
2222
If you haven't used JuMP before, start with the tutorial
23-
[Getting started with JuMP](https://jump.dev/JuMP.jl/stable/tutorials/Getting%20started/getting_started_with_JuMP/)
23+
[Getting started with JuMP](https://jump.dev/JuMP.jl/stable/tutorials/getting_started/getting_started_with_JuMP/)
2424

2525
### linprog
2626

src/sets.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,7 +1063,7 @@ The set corresponding to the special ordered set (SOS) constraint of type 1.
10631063
Of the variables in the set, at most one can be nonzero.
10641064
The `weights` induce an ordering of the variables; as such, they should be unique values.
10651065
The *k*th element in the set corresponds to the *k*th weight in `weights`.
1066-
See [here](http://lpsolve.sourceforge.net/5.5/SOS.htm) for a description of SOS constraints and their potential uses.
1066+
See [here](https://lpsolve.sourceforge.net/5.5/SOS.htm) for a description of SOS constraints and their potential uses.
10671067
"""
10681068
struct SOS1{T<:Real} <: AbstractVectorSet
10691069
weights::Vector{T}
@@ -1076,7 +1076,7 @@ The set corresponding to the special ordered set (SOS) constraint of type 2.
10761076
Of the variables in the set, at most two can be nonzero, and if two are nonzero, they must be adjacent in the ordering of the set.
10771077
The `weights` induce an ordering of the variables; as such, they should be unique values.
10781078
The *k*th element in the set corresponds to the *k*th weight in `weights`.
1079-
See [here](http://lpsolve.sourceforge.net/5.5/SOS.htm) for a description of SOS constraints and their potential uses.
1079+
See [here](https://lpsolve.sourceforge.net/5.5/SOS.htm) for a description of SOS constraints and their potential uses.
10801080
"""
10811081
struct SOS2{T<:Real} <: AbstractVectorSet
10821082
weights::Vector{T}

0 commit comments

Comments
 (0)