Skip to content

Add solver READMEs to documentation #1633

@odow

Description

@odow

For JuMP 1.0, I think we should add the solver READMEs to the documentation. Something like this (I mocked it up for MOI, but it should be for JuMP):
image
This requires a 1.0 tag for each solver first so the API is stable. We don't want to release JuMP with the documentation baked in, and then releases a breaking version of the solver so that the documentation is out-of-date.

In doing so, we should standardize the README for each solver. At the moment solver documentation is lacking, and things like setting options aren't uniformly well documented. If the solver has proper documentation that's okay, the README can just link to that.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: DocumentationThis issue requires changes to the documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions