From cef758077e20d30d90d760bf015bfeeda60f1c67 Mon Sep 17 00:00:00 2001 From: odow Date: Thu, 18 Nov 2021 15:12:10 +1300 Subject: [PATCH 1/2] [doc] clarify documentation of solvers --- docs/src/tutorials/implementing.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/src/tutorials/implementing.md b/docs/src/tutorials/implementing.md index e4755cf3bc..c283e2ffc1 100644 --- a/docs/src/tutorials/implementing.md +++ b/docs/src/tutorials/implementing.md @@ -189,6 +189,22 @@ Project.toml code formatting using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl). Check existing solvers or JuMP.jl for details. +### Documentation + +Your package must include documentation explaining how to use the package. The +easiest approach is to include documentation in your `README.md`. A more +involved option is to use [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl). + +Examples of packages with README-based documentation include: + * [Cbc.jl](https://github.com/jump-dev/Cbc.jl) + * [Gurobi.jl](https://github.com/jump-dev/Gurobi.jl) + * [SCS.jl](https://github.com/jump-dev/SCS.jl) + +Examples of packages with Documenter.jl-based documentation include: + * [Alpine.jl](https://github.com/lanl-ansi/Alpine.jl) + * [COSMO.jl](https://github.com/oxfordcontrol/COSMO.jl) + * [Juniper.jl](https://github.com/lanl-ansi/Juniper.jl) + ### Setup tests The best way to implement an interface to MathOptInterface is via From 8c57710955f6ebaed914be9771b6648c0713ccbb Mon Sep 17 00:00:00 2001 From: Oscar Dowson Date: Fri, 19 Nov 2021 09:36:30 +1300 Subject: [PATCH 2/2] Update implementing.md --- docs/src/tutorials/implementing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/tutorials/implementing.md b/docs/src/tutorials/implementing.md index c283e2ffc1..a77e8fc51d 100644 --- a/docs/src/tutorials/implementing.md +++ b/docs/src/tutorials/implementing.md @@ -197,10 +197,10 @@ involved option is to use [Documenter.jl](https://github.com/JuliaDocs/Documente Examples of packages with README-based documentation include: * [Cbc.jl](https://github.com/jump-dev/Cbc.jl) - * [Gurobi.jl](https://github.com/jump-dev/Gurobi.jl) + * [HiGHS.jl](https://github.com/jump-dev/HiGHS.jl) * [SCS.jl](https://github.com/jump-dev/SCS.jl) -Examples of packages with Documenter.jl-based documentation include: +Examples of packages with Documenter-based documentation include: * [Alpine.jl](https://github.com/lanl-ansi/Alpine.jl) * [COSMO.jl](https://github.com/oxfordcontrol/COSMO.jl) * [Juniper.jl](https://github.com/lanl-ansi/Juniper.jl)