JuliaOpt · mlubin · Jun 14, 2017 · Jun 14, 2017 · Jun 14, 2017 · Jun 14, 2017
diff --git a/.travis.yml b/.travis.yml
@@ -17,7 +17,7 @@ addons:
 script:
     - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
     - julia -e 'Pkg.clone(pwd())'
-    - julia -e 'Pkg.test("MathProgBase")'
+    #- julia -e 'Pkg.test("MathProgBase")'
 after_success:
     - julia -e 'Pkg.add("Documenter")'
     - julia -e 'cd(Pkg.dir("MathProgBase")); include(joinpath("docs", "make.jl"))'
diff --git a/docs/make.jl b/docs/make.jl
@@ -4,7 +4,19 @@ makedocs(
     format = :html,
     sitename = "MathProgBase",
     pages = [
-        "index.md",
+        "Introduction" => "index.md",
+        "High-level Interfaces" => "highlevel.md",
+        "Solver Interface" => [
+             "Basics" => "basics.md",
+             "Variables" => "variables.md",
+             "Objectives" => "objectives.md",
+             "Constraints" => "constraints.md",
+             "Sets" => "sets.md",
+             "Attributes" => "attributes.md",
+             "Status Codes" => "statuscodes.md",
+             "Duals" => "duals.md",
+             "NLP" => "nlp.md"],
+        "Choosing Solver" => "choosingsolver.md"
     ]
 )
 
@@ -14,5 +26,6 @@ deploydocs(
     osname = "linux",
     julia  = "0.6",
     deps   = nothing,
-    make   = nothing
+    make   = nothing,
+    latest = "break_everything"
 )
diff --git a/docs/src/attributes.md b/docs/src/attributes.md
@@ -0,0 +1,61 @@
+```@meta
+CurrentModule = MathProgBase
+```
+
+These are used to get and set properties of the model.
+
+```@docs
+AbstractAttribute
+cangetattribute
+getattribute
+cansetattribute
+setattribute!
+```
+
+## Scalar Attributes
+
+```@docs
+ObjectiveValue
+ObjectiveBound
+RelativeGap
+SolveTime
+Sense
+SimplexIterations
+BarrierIterations
+NodeCount
+RawSolver
+ResultCount
+VariableCount
+ConstraintCount
+SupportsVariablesInSet
+SupportsAffineInSet
+SupportsQuadraticInSet
+```
+
+## Variable Attributes
+
+These attributes are associated with variables. Calls to `getattribute` and `setattribute!` should include as an argument a single `VariableReference` or a vector of `VariableReference` objects.
+
+```@docs
+VariablePrimalStart
+VariableLowerBoundDualStart
+VariableUpperBoundDualStart
+VariableLowerBound
+VariableUpperBound
+VariablePrimal
+VariableLowerBoundDual
+VariableUpperBoundDual
+```
+
+## Constraint Attributes
+
+These attributes are associated with constraints. Calls to `getattribute` and `setattribute!` should include as an argument a single `ConstraintReference` or a vector of `ConstriaintReference{T}` objects.
+
+```@docs
+ConstraintPrimalStart
+ConstraintDualStart
+ConstraintPrimal
+ConstraintDual
+```
+
+
diff --git a/docs/src/basics.md b/docs/src/basics.md
@@ -0,0 +1,20 @@
+
+```@meta
+CurrentModule = MathProgBase
+```
+
+Some introduction to MPB API. List basic standalone methods.
+
+```@docs
+AbstractModel
+AbstractNLPModel
+AbstractMathProgSolver
+```
+
+
+```@docs
+Model
+NLPModel
+optimize!
+freemodel!
+```
diff --git a/docs/src/choosingsolver.md b/docs/src/choosingsolver.md
@@ -0,0 +1,10 @@
+# Choosing Solvers
+
+Solvers and solver-specific parameters are specified by [`AbstractMathProgSolver`](@ref) objects, which are provided by particular solver packages. For example, the `Clp` package exports a `ClpSolver` object, which can be passed to [`linprog`](@ref) as follows::
+
+```julia
+    using Clp
+    linprog([-1,0],[2 1],'<',1.5, ClpSolver())
+```
+
+Options are passed as keyword arguments, for example, `ClpSolver(LogLevel=1)`. See the [Clp](https://github.com/mlubin/Clp.jl), [Cbc](https://github.com/mlubin/Cbc.jl), [GLPKMathProgInterface](https://github.com/JuliaOpt/GLPKMathProgInterface.jl), and [Gurobi](https://github.com/JuliaOpt/Gurobi.jl) packages for more information.
diff --git a/docs/src/constraints.md b/docs/src/constraints.md
@@ -0,0 +1,15 @@
+```@meta
+CurrentModule = MathProgBase
+```
+
+How to add and modify constraints.
+```@docs
+VariablewiseConstraintReference
+AffineConstraintReference
+QuadraticConstraintReference
+candelete(::AbstractMathProgModel,::ConstraintReference)
+isvalid(::AbstractMathProgModel,::ConstraintReference)
+delete!(::AbstractMathProgModel,::ConstraintReference)
+addconstraint!
+modifyconstraint!
+```
diff --git a/docs/src/duals.md b/docs/src/duals.md
@@ -0,0 +1,7 @@
+```@meta
+CurrentModule = MathProgBase
+```
+
+
+We take the convention that duals on variable lower bounds should be nonnegative, duals on variable upper bounds should be nonpositive, and duals on closed convex cones should belong to the dual cone.
+
diff --git a/docs/src/highlevel.md b/docs/src/highlevel.md
@@ -0,0 +1,23 @@
+```@meta
+	CurrentModule = MathProgBase
+```
+
+## Linear Programming
+
+```@docs
+linprog
+buildlp
+solvelp
+```
+
+## Mixed-integer Programming
+
+```@docs
+mixintprog
+```
+
+## Quadratic Programming
+
+```@docs
+quadprog
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1 +1,3 @@
-# MathProgBase documentation
+# MathProgBase
+
+[MathProgBase.jl](https://github.com/JuliaOpt/MathProgBase.jl) is a standarized API for Mathematical Optimization solvers. [JuMP](https://github.com/JuliaOpt/JuMP.jl) uses MathProgBase as a solver-independent low-level backend, but MathProgBase may be used freely without JuMP. In addition to the low-level API, MathProgBase provides one-shot functions for linear, mixed-integer, and quadratic optimiztion problems.
diff --git a/docs/src/nlp.md b/docs/src/nlp.md
@@ -0,0 +1,35 @@
+```@meta
+    CurrentModule = MathProgBase
+```
+
+# NonLinear Programming Interface (NLP)
+
+
+## NLP Methods
+
+```@docs
+loadnlp!
+initialize
+features_available
+eval_f
+eval_grad_f
+jac_structure
+hesslag_structure
+eval_jac_g
+eval_jac_prod
+eval_jac_prod_t
+eval_hesslag_prod
+eval_hesslag
+isobjlinear(::AbstractNLPEvaluator)
+isobjquadratic(::AbstractNLPEvaluator)
+isconstrlinear(::AbstractNLPEvaluator, i::Integer)
+obj_expr
+constr_expr
+```
+
+## NLP Attributes
+
+```@docs
+ConstraintNLPDual
+ConstraintNLPDualStart
+```
diff --git a/docs/src/objectives.md b/docs/src/objectives.md
@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = MathProgBase
+```
+
+How to add and set objectives.
+```@docs
+setobjective!
+modifyobjective!
+getobjective
+```
diff --git a/docs/src/sets.md b/docs/src/sets.md
@@ -0,0 +1,14 @@
+```@meta
+CurrentModule = MathProgBase
+```
+
+
+List of sets.
+```@docs
+NonNegative
+NonPositive
+Zero
+Interval
+Integers
+Binaries
+```
diff --git a/docs/src/statuscodes.md b/docs/src/statuscodes.md
@@ -0,0 +1,28 @@
+```@meta
+CurrentModule = MathProgBase
+```
+
+
+## Termination Status
+
+The `TerminationStatus` attribute is meant to explain the reason why the solver stopped executing. The value of the attribute is of type `TerminationStatusCode`.
+
+```@docs
+TerminationStatus
+TerminationStatusCode
+```
+
+## Result Status
+
+The `PrimalStatus` and `DualStatus` attributes are meant to explain how to interpret the result returned by the solver. The value of the attributes are of type `ResultStatusCode`.
+
+```@docs
+PrimalStatus
+DualStatus
+ResultStatusCode
+```
+
+## Basis Status
+
+TODO: attributes and status codes for LP basis status
+
diff --git a/docs/src/variables.md b/docs/src/variables.md
@@ -0,0 +1,14 @@
+
+```@meta
+CurrentModule = MathProgBase
+```
+
+```@docs
+VariableReference
+candelete(::AbstractMathProgModel,::VariableReference)
+isvalid(::AbstractMathProgModel,::VariableReference)
+delete!(::AbstractMathProgModel,::VariableReference)
+addvariables!
+addvariable!
+```
+
diff --git a/src/HighLevelInterface/HighLevelInterface.jl b/src/HighLevelInterface/HighLevelInterface.jl
@@ -1,8 +1,3 @@
-module HighLevelInterface
-
-using ..SolverInterface
-using ..MathProgBase
-
 function warn_no_inf(T)
     if !(isinf(typemin(T)) && isinf(typemax(T)))
         Base.warn_once("Element type $T does not have an infinite value. Note that this may artifically introduce ranged (two-sided) constraints. To avoid this, consider casting the problem data to Float64.")
@@ -12,5 +7,3 @@ end
 include("linprog.jl")
 include("mixintprog.jl")
 include("quadprog.jl")
-
-end