Skip to content

More documentation changes to manual #1281

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 5 commits into from
Mar 14, 2021
Merged

More documentation changes to manual #1281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1b32def
More documentation changes to manual
odow Mar 10, 2021
55a74e6
Update constraints documentation
odow Mar 10, 2021
00e8080
Update variable docs
odow Mar 10, 2021
bdc51dd
More restructuring
odow Mar 14, 2021
acc0343
Refactor reference
odow Mar 14, 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
17 changes: 14 additions & 3 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,24 @@ makedocs(
],
"Manual" => [
"manual/standard_form.md",
"manual/models.md",
"manual/variables.md",
"manual/constraints.md",
"manual/status.md",
"manual/solutions.md",
"manual/modification.md",
"manual/basic_usage.md",
"manual/example.md",
"manual/implementing.md",
],
"API Reference" => "reference/reference.md",
"API Reference" => [
"reference/standard_form.md",
"reference/models.md",
"reference/variables.md",
"reference/constraints.md",
"reference/modification.md",
"reference/nonlinear.md",
"reference/callbacks.md",
"reference/errors.md",
],
"Submodules" => [
"Benchmarks" => [
"Overview" => "submodules/Benchmarks/overview.md",
Expand Down
8 changes: 5 additions & 3 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# MathOptInterface

!!! warning
This documentation is still under construction. If you need help with JuMP,
read the [JuMP documentation](https://jump.dev/JuMP.jl/stable/) instead. If
you are writing a solver interface and need help with MOI, join the
[developer chatroom](https://gitter.im/JuliaOpt/JuMP-dev) and ask away!

# MathOptInterface

# What is MathOptInterface?

[MathOptInterface.jl](https://github.com/jump-dev/MathOptInterface.jl) (MOI) is
an abstraction layer designed to provide a unified interface to mathematical
optimization solvers so that users do not need to understand multiple
Expand Down Expand Up @@ -36,7 +38,7 @@ you know where to look for certain things.
submodules within MOI. These submodules are not required to interface a solver
with MOI, but they make the job much easier.

## Citing JuMP
## Citing MathOptInterface

A [paper describing the design and features of MathOptInterface](https://arxiv.org/abs/2002.03447)
is available on [arXiv](https://arxiv.org).
Expand Down
Loading