diff --git a/docs/make.jl b/docs/make.jl index 42d7590..81e21ed 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -8,7 +8,6 @@ makedocs( format = Documenter.HTML(assets = ["assets/style.css"], prettyurls = get(ENV, "CI", nothing) == "true"), sitename = "NLPModelsModifiers.jl", pages = ["Home" => "index.md", - "Models" => "models.md", "Reference" => "reference.md" ] ) diff --git a/docs/src/index.md b/docs/src/index.md index db60978..e32bb39 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -12,17 +12,6 @@ Install NLPModelsModifiers.jl with the following command. pkg> add NLPModelsModifiers ``` -## Models - -The following models are implemented. - -- [`FeasibilityFormNLS`](@ref): Creates residual variables and constraints, so that the residual is linear. -- [`FeasibilityResidual`](@ref): Creates a nonlinear least squares model from an equality constrained problem in which the residual function is the constraints function. -- [`LBFGSModel`](@ref): Creates a model using a LBFGS approximation to the Hessian using an existing NLPModel. -- [`LSR1Model`](@ref): Creates a model using a LSR1 approximation to the Hessian using an existing NLPModel. -- [`SlackModel`](@ref): Creates an equality constrained problem with bounds on the variables using an existing NLPModel. -- [`SlackNLSModel`](@ref): Creates an equality constrained nonlinear least squares problem with bounds on the variables using an existing NLSModel. - ## License This content is released under the [MPL2.0](https://www.mozilla.org/en-US/MPL/2.0/) License. diff --git a/docs/src/models.md b/docs/src/models.md deleted file mode 100644 index c1bfd1c..0000000 --- a/docs/src/models.md +++ /dev/null @@ -1,17 +0,0 @@ -# Models - -- [`FeasibilityFormNLS`](@ref): Creates residual variables and constraints, so that the residual is linear. -- [`FeasibilityResidual`](@ref): Creates a nonlinear least squares model from an equality constrained problem in which the residual function is the constraints function. -- [`LBFGSModel`](@ref): Creates a model using a LBFGS approximation to the Hessian using an existing NLPModel. -- [`LSR1Model`](@ref): Creates a model using a LSR1 approximation to the Hessian using an existing NLPModel. -- [`SlackModel`](@ref): Creates an equality constrained problem with bounds on the variables using an existing NLPModel. -- [`SlackNLSModel`](@ref): Creates an equality constrained nonlinear least squares problem with bounds on the variables using an existing NLSModel. - -```@docs -FeasibilityFormNLS -FeasibilityResidual -LBFGSModel -LSR1Model -SlackModel -SlackNLSModel -``` \ No newline at end of file diff --git a/docs/src/reference.md b/docs/src/reference.md index 2dec9b1..72ca384 100644 --- a/docs/src/reference.md +++ b/docs/src/reference.md @@ -1,4 +1,17 @@ # Reference - +​ +## Contents +​ +```@contents +Pages = ["reference.md"] +``` +​ +## Index +​ ```@index +Pages = ["reference.md"] ``` +​ +```@autodocs +Modules = [NLPModelsModifiers] +``` \ No newline at end of file