Add import MathOptInterface as MOI to DocTestSetup (#2746)

odow · web-flow · commit 6e61a86ec350 · 2025-05-02T10:38:48.000+12:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -123,6 +123,13 @@ end
 # link checking. Inn production we replace this by running the LaTeX build.
 write(joinpath(@__DIR__, "src", "MathOptInterface.pdf"), "")
 
+Documenter.DocMeta.setdocmeta!(
+    MathOptInterface,
+    :DocTestSetup,
+    :(import MathOptInterface as MOI);
+    recursive = true,
+)
+
 @time Documenter.makedocs(
     sitename = "MathOptInterface",
     authors = "The JuMP core developers and contributors",
diff --git a/src/Benchmarks/Benchmarks.jl b/src/Benchmarks/Benchmarks.jl
@@ -53,8 +53,6 @@ Extra `kwargs` are based to `BenchmarkTools.run`.
 ## Example
 
 ```julia
-julia> import MathOptInterface as MOI
-
 julia> import GLPK
 
 julia> my_suite = MOI.Benchmarks.suite(() -> GLPK.Optimizer());
@@ -100,8 +98,6 @@ Extra `kwargs` are based to `BenchmarkTools.run`.
 ## Example
 
 ```julia
-julia> import MathOptInterface as MOI
-
 julia> import GLPK
 
 julia> my_suite = MOI.Benchmarks.suite(() -> GLPK.Optimizer());
diff --git a/src/Bridges/Bridges.jl b/src/Bridges/Bridges.jl
@@ -41,7 +41,7 @@ coefficient type `T`, as well as the bridges in the list returned by the
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> model = MOI.Utilities.Model{Float64}();
 
 julia> bridged_model = MOI.Bridges.full_bridge_optimizer(model, Float64);
@@ -273,7 +273,7 @@ and [`MOI.ConstraintPrimalStart`](@ref) to throw [`MOI.GetAttributeNotAllowed`](
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI), filter=r"[0-9.]+s"
+```jldoctest; filter=r"[0-9.]+s"
 julia> MOI.Bridges.runtests(
            MOI.Bridges.Constraint.ZeroOneBridge,
            model -> MOI.add_constrained_variable(model, MOI.ZeroOne()),
@@ -423,7 +423,7 @@ Run a series of tests that check the correctness of `Bridge`.
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI), filter=r"[0-9.]+s"
+```jldoctest; filter=r"[0-9.]+s"
 julia> MOI.Bridges.runtests(
            MOI.Bridges.Constraint.ZeroOneBridge,
            \"\"\"
diff --git a/src/Bridges/Constraint/bridge.jl b/src/Bridges/Constraint/bridge.jl
@@ -61,7 +61,7 @@ The [`SplitIntervalBridge`](@ref) bridges a [`MOI.VariableIndex`](@ref)-in-[`MOI
 constraint into a [`MOI.VariableIndex`](@ref)-in-[`MOI.GreaterThan`](@ref) and a
 [`MOI.VariableIndex`](@ref)-in-[`MOI.LessThan`](@ref) constraint.
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> MOI.Bridges.Constraint.concrete_bridge_type(
            MOI.Bridges.Constraint.SplitIntervalBridge{Float64},
            MOI.VariableIndex,
diff --git a/src/Bridges/Constraint/single_bridge_optimizer.jl b/src/Bridges/Constraint/single_bridge_optimizer.jl
@@ -16,7 +16,7 @@ and unsupported by `model`.
 
 ## Example
 
-```jldoctest con_singlebridgeoptimizer; setup=:(import MathOptInterface as MOI)
+```jldoctest con_singlebridgeoptimizer
 julia> struct MyNewBridge{T} <: MOI.Bridges.Constraint.AbstractBridge end
 
 julia> bridge = MOI.Bridges.Constraint.SingleBridgeOptimizer{MyNewBridge{Float64}}(
diff --git a/src/Bridges/Objective/single_bridge_optimizer.jl b/src/Bridges/Objective/single_bridge_optimizer.jl
@@ -16,7 +16,7 @@ and unsupported by `model`.
 
 ## Example
 
-```jldoctest obj_singlebridgeoptimizer; setup=:(import MathOptInterface as MOI)
+```jldoctest obj_singlebridgeoptimizer
 julia> struct MyNewBridge{T} <: MOI.Bridges.Objective.AbstractBridge end
 
 julia> bridge = MOI.Bridges.Objective.SingleBridgeOptimizer{MyNewBridge{Float64}}(
diff --git a/src/Bridges/Variable/bridge.jl b/src/Bridges/Variable/bridge.jl
@@ -39,7 +39,7 @@ solver.
 
 ## Example
 
-```jldoctest; setup=(import MathOptInterface as MOI)
+```jldoctest
 julia> MOI.Bridges.Variable.supports_constrained_variable(
            MOI.Bridges.Variable.NonposToNonnegBridge{Float64},
            MOI.Nonpositives,
@@ -78,8 +78,6 @@ variables in [`MOI.Nonnegatives`](@ref) by the
 [`VectorizeBridge`](@ref):
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> MOI.Bridges.Variable.concrete_bridge_type(
            MOI.Bridges.Variable.VectorizeBridge{Float64},
            MOI.GreaterThan{Float64},
diff --git a/src/Bridges/Variable/single_bridge_optimizer.jl b/src/Bridges/Variable/single_bridge_optimizer.jl
@@ -21,7 +21,7 @@ by the bridge `BT` and unsupported by `model`.
 
 ## Example
 
-```jldoctest var_singlebridgeoptimizer; setup=:(import MathOptInterface as MOI)
+```jldoctest var_singlebridgeoptimizer
 julia> struct MyNewBridge{T} <: MOI.Bridges.Variable.AbstractBridge end
 
 julia> bridge = MOI.Bridges.Variable.SingleBridgeOptimizer{MyNewBridge{Float64}}(
diff --git a/src/Bridges/bridge.jl b/src/Bridges/bridge.jl
@@ -203,7 +203,7 @@ type `BT` add.
 
 ## Example
 
-```jldoctest; setup=(import MathOptInterface as MOI)
+```jldoctest
 julia> MOI.Bridges.added_constrained_variable_types(
            MOI.Bridges.Variable.NonposToNonnegBridge{Float64},
        )
@@ -229,7 +229,7 @@ add.
 
 ## Example
 
-```jldoctest; setup=(import MathOptInterface as MOI)
+```jldoctest
 julia> MOI.Bridges.added_constraint_types(
            MOI.Bridges.Constraint.ZeroOneBridge{Float64},
        )
@@ -254,7 +254,7 @@ set.
 
 ## Example
 
-```jldoctest; setup=(import MathOptInterface as MOI)
+```jldoctest
 julia> MOI.Bridges.set_objective_function_type(
            MOI.Bridges.Objective.FunctionizeBridge{Float64},
        )
@@ -311,7 +311,7 @@ constraint.
 For this reason, the [`Bridges.Constraint.FunctionConversionBridge`](@ref) is
 given a cost of `10`:
 
-```jldoctest; setup=(import MathOptInterface as MOI)
+```jldoctest
 julia> F = MOI.ScalarQuadraticFunction{Float64};
 
 julia> G = MOI.ScalarAffineFunction{Float64};
diff --git a/src/Bridges/lazy_bridge_optimizer.jl b/src/Bridges/lazy_bridge_optimizer.jl
@@ -24,7 +24,7 @@ and [`full_bridge_optimizer`](@ref).
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> model = MOI.Bridges.LazyBridgeOptimizer(MOI.Utilities.Model{Float64}());
 
 julia> MOI.Bridges.add_bridge(model, MOI.Bridges.Variable.FreeBridge{Float64})
diff --git a/src/Nonlinear/ReverseAD/utils.jl b/src/Nonlinear/ReverseAD/utils.jl
@@ -182,8 +182,6 @@ end.
 ## Examples
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x = [(1, 2, 3), (4, 5, 6), (7, 8, 9)]
 3-element Vector{Tuple{Int64, Int64, Int64}}:
  (1, 2, 3)
diff --git a/src/Nonlinear/SymbolicAD/SymbolicAD.jl b/src/Nonlinear/SymbolicAD/SymbolicAD.jl
@@ -22,8 +22,6 @@ Return a simplified copy of the function `f`.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x = MOI.VariableIndex(1)
 MOI.VariableIndex(1)
 
@@ -52,8 +50,6 @@ new object if `f` can be represented in a simpler type.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x = MOI.VariableIndex(1)
 MOI.VariableIndex(1)
 
@@ -356,8 +352,6 @@ Return a sorted list of the `MOI.VariableIndex` present in the function `f`.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x = MOI.VariableIndex.(1:3)
 3-element Vector{MathOptInterface.VariableIndex}:
  MOI.VariableIndex(1)
@@ -463,8 +457,6 @@ simplified expression of the derivative.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x = MOI.VariableIndex(1)
 MOI.VariableIndex(1)
 
diff --git a/src/Nonlinear/evaluator.jl b/src/Nonlinear/evaluator.jl
@@ -16,8 +16,6 @@ Return the 1-indexed value of the constraint index `c` in `evaluator`.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Nonlinear.Model()
 A Nonlinear.Model with:
  0 objectives
diff --git a/src/Nonlinear/model.jl b/src/Nonlinear/model.jl
@@ -50,8 +50,6 @@ To remove the objective, pass `nothing`.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Nonlinear.Model()
 A Nonlinear.Model with:
  0 objectives
@@ -90,8 +88,6 @@ Parse `expr` into a [`Expression`](@ref) and add to `model`. Returns an
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Nonlinear.Model();
 
 julia> x = MOI.VariableIndex(1);
@@ -130,8 +126,6 @@ solution information.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Nonlinear.Model();
 
 julia> x = MOI.VariableIndex(1);
@@ -165,8 +159,6 @@ Delete the constraint index `c` from `model`.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Nonlinear.Model()
 A Nonlinear.Model with:
  0 objectives
@@ -220,8 +212,6 @@ and used to modify the value of the parameter.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Nonlinear.Model()
 A Nonlinear.Model with:
  0 objectives
diff --git a/src/Nonlinear/operators.jl b/src/Nonlinear/operators.jl
@@ -105,8 +105,6 @@ The list of univariate operators that are supported by default.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> MOI.Nonlinear.DEFAULT_UNIVARIATE_OPERATORS
 73-element Vector{Symbol}:
  :+
@@ -141,8 +139,6 @@ The list of multivariate operators that are supported by default.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> MOI.Nonlinear.DEFAULT_MULTIVARIATE_OPERATORS
 9-element Vector{Symbol}:
  :+
@@ -550,8 +546,6 @@ If `op isa Integer`, then `op` is the index in
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> r = MOI.Nonlinear.OperatorRegistry();
 
 julia> MOI.Nonlinear.eval_univariate_function(r, :abs, -1.2)
@@ -603,8 +597,6 @@ If `op isa Integer`, then `op` is the index in
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> r = MOI.Nonlinear.OperatorRegistry();
 
 julia> MOI.Nonlinear.eval_univariate_gradient(r, :abs, -1.2)
@@ -656,8 +648,6 @@ If `op isa Integer`, then `op` is the index in
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> r = MOI.Nonlinear.OperatorRegistry();
 
 julia> MOI.Nonlinear.eval_univariate_function_and_gradient(r, :abs, -1.2)
@@ -708,8 +698,6 @@ If `op isa Integer`, then `op` is the index in
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> r = MOI.Nonlinear.OperatorRegistry();
 
 julia> MOI.Nonlinear.eval_univariate_hessian(r, :sin, 1.0)
diff --git a/src/Test/Test.jl b/src/Test/Test.jl
@@ -78,8 +78,6 @@ For a nonlinear solver that finds local optima and does not support finding
 dual variables or constraint names:
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> config = MOI.Test.Config(
            Float64;
            optimal_status = MOI.LOCALLY_SOLVED,
diff --git a/src/Utilities/functions.jl b/src/Utilities/functions.jl
@@ -1034,8 +1034,6 @@ The output of `canonical` can be assumed to be a copy of `f`, even for
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x, y, z = MOI.VariableIndex.(1:3);
 
 julia> f = MOI.ScalarAffineFunction(
@@ -1165,8 +1163,6 @@ want to first call [`canonical`](@ref) if that is not guaranteed.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> x = MOI.VariableIndex(1)
 MOI.VariableIndex(1)
 
@@ -2557,8 +2553,6 @@ complex-valued).
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> MOI.Utilities.is_complex(MOI.VariableIndex)
 false
 
diff --git a/src/Utilities/model.jl b/src/Utilities/model.jl
@@ -859,8 +859,6 @@ in MOI. It is parameterized by the coefficient type.
 ## Example
 
 ```jldoctest
-julia> import MathOptInterface as MOI
-
 julia> model = MOI.Utilities.Model{Float64}()
 MOIU.Model{Float64}
 ├ ObjectiveSense: FEASIBILITY_SENSE
diff --git a/src/Utilities/parser.jl b/src/Utilities/parser.jl
@@ -337,7 +337,7 @@ A utility function to aid writing tests.
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> model = MOI.Utilities.Model{Float64}();
 
 julia> MOI.Utilities.loadfromstring!(model, \"\"\"
diff --git a/src/Utilities/penalty_relaxation.jl b/src/Utilities/penalty_relaxation.jl
@@ -34,7 +34,7 @@ this function to compute the violation of the constraint.
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> model = MOI.Utilities.Model{Float64}();
 
 julia> x = MOI.add_variable(model);
@@ -189,7 +189,7 @@ To modify variable bounds, rewrite them as linear constraints.
 
 ## Example
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> model = MOI.Utilities.Model{Float64}();
 
 julia> x = MOI.add_variable(model);
@@ -214,7 +214,7 @@ julia> map[c] isa MOI.ScalarAffineFunction{Float64}
 true
 ```
 
-```jldoctest; setup=:(import MathOptInterface as MOI)
+```jldoctest
 julia> model = MOI.Utilities.Model{Float64}();
 
 julia> x = MOI.add_variable(model);
diff --git a/src/Utilities/product_of_sets.jl b/src/Utilities/product_of_sets.jl
diff --git a/src/Utilities/set_dot.jl b/src/Utilities/set_dot.jl
diff --git a/src/Utilities/sets.jl b/src/Utilities/sets.jl
diff --git a/src/attributes.jl b/src/attributes.jl
diff --git a/src/constraints.jl b/src/constraints.jl
diff --git a/src/functions.jl b/src/functions.jl
diff --git a/src/modifications.jl b/src/modifications.jl
diff --git a/src/nlp.jl b/src/nlp.jl
diff --git a/src/sets.jl b/src/sets.jl
diff --git a/src/variables.jl b/src/variables.jl
