[docs] add READMEs of supported solvers to the documentation

docs/.gitignore

@@ -6,3 +6,4 @@ src/tutorials/*/*.md
 src/moi/
 src/tutorials/linear/transp.txt
 src/release_notes.md
+src/solvers

docs/Project.toml

@@ -2,6 +2,7 @@
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Downloads = "f43a241f-c20a-4ad4-852c-f6b1247861c6"
 GLPK = "60bf3e95-4087-53dc-ae20-288a0d20c6a6"
 HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
 HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
@@ -19,6 +20,7 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SCS = "c946c3f1-0d1f-5ce8-9dea-7daa1f7e2d13"
 SQLite = "0aa819cd-b072-5ff4-a722-6bc24af294d9"
 StatsPlots = "f3b207a7-027a-5e70-b257-86293d7955fd"
+TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 

docs/make.jl

@@ -1,8 +1,10 @@
 import Pkg
 Pkg.pkg"add Documenter#633a95a"
 import Documenter
+import Downloads
 import Literate
 import Test
+import TOML
 
 using JuMP
 const MathOptInterface = MOI
@@ -102,6 +104,29 @@ if !_FAST
     end
 end
 
+# ==============================================================================
+#  Add solver README
+# ==============================================================================
+
+const _SOLVER_DIR = joinpath(@__DIR__, "src", "solvers")
+if isdir(_SOLVER_DIR)
+    rm(_SOLVER_DIR; recursive = true)
+end
+mkdir(_SOLVER_DIR)
+const _LIST_OF_SOLVERS = String[]
+for (solver, data) in TOML.parsefile(joinpath(@__DIR__, "solvers.toml"))
+    user = get(data, "user", "jump-dev")
+    repo = "$solver.jl"
+    tag = get(data, "rev", "master")
+    filename = get(data, "filename", "README.md")
+    Downloads.download(
+        "https://raw.githubusercontent.com/$user/$repo/$tag/$filename",
+        joinpath(@__DIR__, "src", "solvers", "$solver.md"),
+    )
+    push!(_LIST_OF_SOLVERS, "solvers/$solver.md")
+end
+sort!(_LIST_OF_SOLVERS)
+
 # ==============================================================================
 #  JuMP documentation structure
 # ==============================================================================
@@ -214,6 +239,7 @@ const _PAGES = [
         "Style Guide" => "developers/style.md",
         "Roadmap" => "developers/roadmap.md",
     ],
+    "Solvers" => _LIST_OF_SOLVERS,
     "release_notes.md",
 ]
 
@@ -411,7 +437,7 @@ if _PDF
         _remove_literate_footer.(joinpath.(root, dir))
     end
     # Remove release notes from PDF
-    splice!(_PAGES, 7)   # JuMP release notes
+    splice!(_PAGES, 7:8)   # Solvers and JuMP release notes
     pop!(_PAGES[end][2]) # MOI release notes
     latex_platform = _IS_GITHUB_ACTIONS ? "docker" : "native"
     @time Documenter.makedocs(

docs/solvers.toml

@@ -0,0 +1,75 @@
+# [Alpine]
+#   user = "lanl-ansi"
+[AmplNLWriter]
+    rev = "od/readme"
+[BARON]
+    rev = "od/readme"
+[Cbc]
+    rev = "od/readme"
+# [CDCS]
+#   user = "oxfordcontrol"
+# [CDDLib]
+#   user = "JuliaPolyhedra"
+# [Clarabel]
+#   user = "oxfordcontrol"
+[Clp]
+    rev = "od/readme"
+# [COPT]
+#   user = "COPT-Public"
+# [COSMO]
+#   user = "oxfordcontrol"
+[CPLEX]
+    rev = "od/readme"
+[CSDP]
+    rev = "od/readme"
+# [DAQP]
+#   user = "darnstrom"
+#   rev = "main"
+# [DiffOpt]
+# [Dualization]
+# [EAGO]
+#   user = "PSORLab"
+[ECOS]
+    rev = "od/readme"
+# [GAMS]
+#   user = "GAMS-dev"
+[GLPK]
+    rev = "od/readme"
+[Gurobi]
+    rev = "od/readme"
+[HiGHS]
+    rev = "od/readme"
+# [Hypatia]
+#   user = "chriscoey"
+[Ipopt]
+    rev = "od/readme"
+# [Juniper]
+#   user = "lanl-ansi"
+[KNITRO]
+# [MadNLP]
+#   user = "MadNLP"
+[MiniZinc]
+    rev = "od/readme"
+[MosekTools]
+[MultiObjectiveAlgorithms]
+# [NLopt]
+#   user = "JuliaOpt"
+# [OSQP]
+#   user = "osqp"
+# [PATHSolver]
+#   user = "chkwon"
+[Pajarito]
+[Pavito]
+[Penopt]
+# [ProxSDP]
+#   user = "mariohsouto"
+# [SCIP]
+#   user = "scipopt"
+[SCS]
+[SDPA]
+[SDPNAL]
+[SDPT3]
+[SeDuMi]
+# [Tulip]
+#   user = "ds4dm"
+[Xpress]