Embed the stable MathOptInterface docs into JuMP. #2522
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #2522 +/- ##
==========================================
+ Coverage 93.37% 93.50% +0.12%
==========================================
Files 44 44
Lines 5511 5926 +415
==========================================
+ Hits 5146 5541 +395
- Misses 365 385 +20
Continue to review full report at Codecov.
|
|
Before merging this, we should update to the revised MOI docs (v0.9.21) and rewrite the introduction page to make clear that this is a copy of the MOI documentation. |
This makes it easier for the JuMP docs to link to the MOI documentation, and provides a single, unified set of documentation for JuMP/MOI.
|
So thoughts on this? |
|
I like this! |
|
How's this: |
blegat
approved these changes
Apr 26, 2021
|
Done in #2695 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not sure if we should do this (ever, or just yet), but I thought I would see what it looks like and get some feedback.
I'll post the preview link once the build finishes.
https://jump.dev/JuMP.jl/previews/PR2522/moi/
The idea is to make it easier for the JuMP docs to link to the MOI documentation,
and provide a single, unified set of documentation for JuMP/MOI. This should allow us to de-duplicate things like "What is a caching optimizer", and it provides a way for JuMP users to see things like "What sets are supported by MOI"
Things are controlled by pinning the MOI version in
docs/Project.toml, so whenever we release MOI, we should update the pin and tag a new JuMP release to push the new docs.