[docs] add EAGO to packages.toml

[odow]

cc @DimitriAlston

It'll take a while for the docs to run, but once they're finished this preview link will work:

https://jump.dev/JuMP.jl/previews/PR3561/packages/EAGO

We need to fix some typos, and add some more words to the allow-list (https://github.com/jump-dev/JuMP.jl/blob/master/docs/styles/Vocab/JuMP-Vocab/accept.txt).

The bigger problem is going to be the formatting and links. Documenter's Markdown is not the same as GitHub, so things will render differently. I'll take a look once the preview has built. But another alternative is to provide a simplified file just for the JuMP documentation.

This is what InfiniteOpt has done:

JuMP.jl/docs/packages.toml

Line 141 in c831cc6

filename = "docs/jump/README.md"

https://github.com/infiniteopt/InfiniteOpt.jl/blob/master/docs/jump/README.md

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c831cc6) 98.37% compared to head (50b587d) 98.20%.
Report is 5 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3561      +/-   ##
==========================================
- Coverage   98.37%   98.20%   -0.18%     
==========================================
  Files          37       37              
  Lines        5610     5622      +12     
==========================================
+ Hits         5519     5521       +2     
- Misses         91      101      +10     

see 5 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[odow]

@DimitriAlston here are the vale failures. I've added some (not listed here) to the accept.txt.

docs/src/packages/EAGO.md|20 col 317| [Google.Latin] Use 'for example' instead of 'e.g.,'.
docs/src/packages/EAGO.md|106 col 3| [Google.DateFormat] Use 'July 31, 2016' format, not '6/15/2023'.
docs/src/packages/EAGO.md|110 col 54| [Vale.Spelling] Did you really mean 'accomodate'?

Should be accommodate

docs/src/packages/EAGO.md|123 col 146| [Google.Latin] Use 'for example' instead of 'e.g.,'.
docs/src/packages/EAGO.md|123 col 166| [Vale.Spelling] Did you really mean 'Wergert'?

Should be Wengert

docs/src/packages/EAGO.md|130 col 102| [Vale.Spelling] Did you really mean 'Github'?
docs/src/packages/EAGO.md|134 col 70| [Vale.Spelling] Did you really mean 'Github'?

Should be GitHub

docs/src/packages/EAGO.md|143 col 91| [Vale.Spelling] Did you really mean 'lexiographic'?

Should be lexicographic

docs/src/packages/EAGO.md|155 col 17| [Vale.Spelling] Did you really mean 'bibtex'?

Should be BibTeX

docs/src/packages/EAGO.md|172 col 213| [Vale.Spelling] Did you really mean 'contactors'?

Contractors?

docs/src/packages/EAGO.md|178 col 134| [Google.EnDash] Use an em dash ('—') instead of '–'.
docs/src/packages/EAGO.md|180 col 104| [Vale.Spelling] Did you really mean 'Optim'?

Optimization

docs/src/packages/EAGO.md|180 col 119| [Vale.Spelling] Did you really mean 'Softw'?

Software

docs/src/packages/EAGO.md|180 col 137| [Google.EnDash] Use an em dash ('—') instead of '–'.

[DimitriAlston]

I'm thinking it might be better if I do something similar to InfiniteOpt. EAGO's README from v0.8.1 has a lot of unnecessary stuff for this so a simplified version for getting started would be better. Also, I realized a lot of the typos I fixed are on my version and haven't been pushed to GitHub yet.

[odow]

No problem. Unfortunately, it's a bit of a hassle to test things. The best way is to push a commit to EAGO, then comment here with the hash, and I will rebuild the docs with it.

[odow]

I added has_html, so hopefully this time the images will render properly

[DimitriAlston]

The images probably won't work because I renamed and moved them at some point.
I'll have to make these edits tomorrow and send you updated info then.
Thanks for your help.

[DimitriAlston]

Alright, I have added a new README to EAGO for this at https://github.com/PSORLab/EAGO.jl/blob/master/docs/src/jump/README.md.
Am I able to edit this in the future, if necessary, without causing conflicts?

[odow]

Am I able to edit this in the future, if necessary, without causing conflicts?

Yeah. I've updated the commit hash. So if you change, we'll need to update it here. let's see how this one looks

[DimitriAlston]

Oh, I think we forgot to remove has_html = true.

[odow]

My bad. See you in another hour.

[odow]

Thanks for your patience @DimitriAlston

[DimitriAlston]

Thanks for your help!