Skip to content

[doc] clarify documentation of solvers #1663

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.

Sign up for GitHub

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 2 commits into from
Nov 18, 2021
Merged

[doc] clarify documentation of solvers #1663

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cef7580
[doc] clarify documentation of solvers
odow Nov 18, 2021
8c57710
Update implementing.md
odow Nov 18, 2021
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
16 changes: 16 additions & 0 deletions docs/src/tutorials/implementing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,22 @@ Project.toml
code formatting using [JuliaFormatter.jl](https://github.com/domluna/JuliaFormatter.jl).
Check existing solvers or JuMP.jl for details.

### Documentation

Your package must include documentation explaining how to use the package. The
easiest approach is to include documentation in your `README.md`. A more
involved option is to use [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl).

Examples of packages with README-based documentation include:
* [Cbc.jl](https://github.com/jump-dev/Cbc.jl)
* [HiGHS.jl](https://github.com/jump-dev/HiGHS.jl)
* [SCS.jl](https://github.com/jump-dev/SCS.jl)

Examples of packages with Documenter-based documentation include:
* [Alpine.jl](https://github.com/lanl-ansi/Alpine.jl)
* [COSMO.jl](https://github.com/oxfordcontrol/COSMO.jl)
* [Juniper.jl](https://github.com/lanl-ansi/Juniper.jl)

### Setup tests

The best way to implement an interface to MathOptInterface is via
Expand Down