Skip to content

[docs] add COSMO and Clarabel to the documentation #3366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
May 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ TokenIgnores = \
\$.+?\$, \
\]\(@(ref|id).+?\), \
AMPL: A Modeling Language for Mathematical Programming

; TODO(odow): remove at some point
[docs/src/packages/Clarabel.md]
Google.Latin = NO
16 changes: 16 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,23 @@ for (solver, data) in TOML.parsefile(joinpath(@__DIR__, "packages.toml"))
lines = readlines(out_filename)
open(out_filename, "w") do io
closing_tag = nothing
math_open = false
for line in lines
line = replace(
line,
"#gh-light-mode-only\"" => "\" class=\"display-light-only\"",
)
line = replace(
line,
"#gh-dark-mode-only\"" => "\" class=\"display-dark-only\"",
)
for ext in ("svg", "png", "gif")
line = replace(line, ".$ext\"" => ".$ext?raw=true\"")
end
if line == "\$\$"
line = math_open ? "```" : "```math"
math_open = !math_open
end
tag = if startswith(line, "<img")
"/>"
else
Expand Down
14 changes: 8 additions & 6 deletions docs/packages.toml
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,17 @@
[CDDLib]
user = "JuliaPolyhedra"
rev = "9700752f849845bc8d8477928baf3df920daadd6"
# [Clarabel]
# user = "oxfordcontrol"
# has_html = true
[Clarabel]
user = "oxfordcontrol"
rev = "v0.5.0"
has_html = true
[COPT]
user = "COPT-Public"
rev = "2d93e079645eff773552bb5da44c3024450fe990"
# [COSMO]
# user = "oxfordcontrol"
# has_html = true
[COSMO]
user = "oxfordcontrol"
rev = "c95bf89f111a83f52febf326615a091ad0418f00"
has_html = true
[DAQP]
user = "darnstrom"
rev = "70623ed816916a0f3c3a51b65b166efae364b98d"
Expand Down
6 changes: 6 additions & 0 deletions docs/styles/Vocab/JuMP-Vocab/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ compat
dataframe(?s)
datastructure
destructuring
dev
discretized
docstring(?s)
doctest(?s)
Expand Down Expand Up @@ -76,7 +77,9 @@ Relatedly
rhs
satisfiability
scalarization(?s)
SDP(?s)
[Ss]emi(continuous|integer|definite)
SOCP(?s)
subgradient
subproblem(?s)
subtour(?s)
Expand All @@ -99,6 +102,9 @@ CDDLib
Clarabel
Clp
CPLEXLink
COSMO
COSMOAccelerators
cosmo
Couenne
Divio
Dualization
Expand Down