Skip to content

Commit d0db0e5

Browse files
authored
[docs] drop GitHub owner from solvers and extensions (#4195)
1 parent 024b5ba commit d0db0e5

4 files changed

Lines changed: 18 additions & 34 deletions

File tree

docs/make_utilities.jl

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -430,19 +430,18 @@ end
430430
function list_of_solvers_and_extensions()
431431
_LIST_OF_SOLVERS = Pair{String,String}[]
432432
_LIST_OF_EXTENSIONS =
433-
Pair{String,String}["rafaqz/DimensionalData.jl"=>"extensions/DimensionalData.md",]
433+
Pair{String,String}["DimensionalData.jl"=>"extensions/DimensionalData.md",]
434434
for (solver, data) in TOML.parsefile(joinpath(@__DIR__, "packages.toml"))
435-
user = get(data, "user", "jump-dev")
436-
user_repo = string(user, "/", solver, get(data, "ext", ".jl"))
435+
repo = string(solver, get(data, "ext", ".jl"))
437436
if get(data, "extension", false)
438-
push!(_LIST_OF_EXTENSIONS, user_repo => "packages/$solver.md")
437+
push!(_LIST_OF_EXTENSIONS, repo => "packages/$solver.md")
439438
else
440-
push!(_LIST_OF_SOLVERS, user_repo => "packages/$solver.md")
439+
push!(_LIST_OF_SOLVERS, repo => "packages/$solver.md")
441440
end
442441
end
443442
# Sort, with jump-dev repos at the start.
444-
sort!(_LIST_OF_SOLVERS; by = x -> (!startswith(x[1], "jump-dev/"), x[1]))
445-
sort!(_LIST_OF_EXTENSIONS; by = x -> (!startswith(x[1], "jump-dev/"), x[1]))
443+
sort!(_LIST_OF_SOLVERS; by = first)
444+
sort!(_LIST_OF_EXTENSIONS; by = first)
446445
pushfirst!(_LIST_OF_SOLVERS, "Introduction" => "packages/solvers.md")
447446
pushfirst!(
448447
_LIST_OF_EXTENSIONS,

docs/src/developers/checklists.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ done in the same commit, or separately. The last commit should have the message
6363
Use the following checklist when adding a new solver to the JuMP documentation.
6464

6565
````
66-
## Basic
66+
## Check the upstream package
6767
6868
- [ ] Check that the solver is a registered Julia package
6969
- [ ] Check that the solver supports the long-term support release of Julia
@@ -74,13 +74,21 @@ Use the following checklist when adding a new solver to the JuMP documentation.
7474
- [ ] Check that the README and/or documentation provides an example of how to
7575
use the solver with JuMP
7676
77-
## Documentation
77+
## Add the package to the supported solvers table
7878
7979
- [ ] Add a new row to the table in `docs/src/installation.md`
8080
81-
## Optional
81+
## Add the package to the `/solvers` section of the JuMP documentation
82+
83+
This section is optional.
8284
8385
- [ ] Add package metadata to `docs/packages.toml`
86+
- [ ] Check that the README has an `## Affiliation` section describing who
87+
develops and maintains the package
88+
- [ ] Check that the README has a `## Getting help` section describing where
89+
the user should ask for help
90+
- [ ] Check that the README has an `## Installation` section describing how to
91+
install the package
8492
````
8593

8694
## Adding a new shape

docs/src/extensions/introduction.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,6 @@ JuMP extensions. The list of extensions is not exhaustive, but instead is
55
intended to help you discover popular JuMP extensions, and to give you an
66
overview of the types of extensions that are possible to write with JuMP.
77

8-
## Affiliation
9-
10-
Packages beginning with `jump-dev/` are developed and maintained by the
11-
JuMP developers.
12-
13-
Packages that do not begin with `jump-dev/` are developed independently. The
14-
developers of these packages requested or consented to the inclusion of their
15-
README contents in the JuMP documentation for the benefit of users.
16-
178
## Adding new extensions
189

1910
Written an extension? Add it to this section of the JuMP documentation by making

docs/src/packages/solvers.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,6 @@ is intended to help you discover commonly used solvers.
77
!!! tip
88
[Supported solvers](@ref) lists all solvers supported by JuMP.
99

10-
## Affiliation
11-
12-
Packages beginning with `jump-dev/` are developed and maintained by the
13-
JuMP developers. In many cases, these packages wrap external solvers that are
14-
not developed by the JuMP developers and, while the Julia packages are all
15-
open-source, in some cases the solvers themselves are closed source commercial
16-
products.
17-
18-
Packages that do not begin with `jump-dev/` are developed independently. The
19-
developers of these packages requested or consented to the inclusion of their
20-
README contents in the JuMP documentation for the benefit of users.
21-
2210
## Adding new solvers
2311

24-
Written a solver? Add it to this section of the JuMP documentation by making
25-
a pull request to the [`docs/packages.toml`](https://github.com/jump-dev/JuMP.jl/blob/master/docs/packages.toml)
26-
file.
12+
Written a solver? See the checklist [Adding a new solver to the documentation](@ref).

0 commit comments

Comments
 (0)