Skip to content

Commit 0aa09c1

Browse files
authored
More documentation changes to manual (jump-dev#1281)
1 parent 26adf96 commit 0aa09c1

File tree

17 files changed

+879
-971
lines changed

17 files changed

+879
-971
lines changed

docs/make.jl

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,24 @@ makedocs(
2525
],
2626
"Manual" => [
2727
"manual/standard_form.md",
28+
"manual/models.md",
29+
"manual/variables.md",
2830
"manual/constraints.md",
29-
"manual/status.md",
31+
"manual/solutions.md",
3032
"manual/modification.md",
31-
"manual/basic_usage.md",
33+
"manual/example.md",
3234
"manual/implementing.md",
3335
],
34-
"API Reference" => "reference/reference.md",
36+
"API Reference" => [
37+
"reference/standard_form.md",
38+
"reference/models.md",
39+
"reference/variables.md",
40+
"reference/constraints.md",
41+
"reference/modification.md",
42+
"reference/nonlinear.md",
43+
"reference/callbacks.md",
44+
"reference/errors.md",
45+
],
3546
"Submodules" => [
3647
"Benchmarks" => [
3748
"Overview" => "submodules/Benchmarks/overview.md",

docs/src/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# MathOptInterface
2-
31
!!! warning
42
This documentation is still under construction. If you need help with JuMP,
53
read the [JuMP documentation](https://jump.dev/JuMP.jl/stable/) instead. If
64
you are writing a solver interface and need help with MOI, join the
75
[developer chatroom](https://gitter.im/JuliaOpt/JuMP-dev) and ask away!
86

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

39-
## Citing JuMP
41+
## Citing MathOptInterface
4042

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

0 commit comments

Comments
 (0)