Skip to content

Commit f907973

Browse files
authored
add more sub-headers to sidebar (#142)
* add headers to sidebar * 4 -> 3 * fix paths * add table of contents sections
1 parent d2d9f76 commit f907973

File tree

5 files changed

+16
-3
lines changed

5 files changed

+16
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The `JuliaNonconvex` organization hosts a number of packages which are available
3131

3232
## Design philosophy
3333

34-
Nonconvex.jl is a Julia package that implements and wraps a number of constrained nonlinear and mixed integer nonlinear programming solvers. There are 4 unique features of Nonconvex.jl compared to similar packages such as JuMP.jl and NLPModels.jl:
34+
Nonconvex.jl is a Julia package that implements and wraps a number of constrained nonlinear and mixed integer nonlinear programming solvers. There are 3 features of Nonconvex.jl compared to similar packages such as JuMP.jl and NLPModels.jl:
3535

3636
1. Emphasis on a function-based API. Objectives and constraints are normal Julia functions.
3737
2. The ability to nest algorithms to create more complicated algorithms.

docs/make.jl

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ makedocs(
66
pages = [
77
"Getting started" => "index.md",
88
"Problem definition" => "problem/problem.md",
9-
"Gradients, Jacobians and Hessians" => "gradients/gradients.md",
9+
"Gradients, Jacobians and Hessians" => [
10+
"Overview" => "gradients/gradients.md",
11+
"gradients/user_defined.md",
12+
"gradients/other_ad.md",
13+
"gradients/chainrules_fd.md",
14+
"gradients/sparse.md",
15+
"gradients/symbolic.md",
16+
"gradients/implicit.md",
17+
"gradients/history.md",
18+
],
1019
"Algorithms" => [
1120
"Overview" => "algorithms/algorithms.md",
1221
"algorithms/mma.md",

docs/src/gradients/gradients.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ In some cases, function modifiers can even be composed on top of each other to c
1313

1414
> In `Nonconvex`, function modifiers modify the behaviour of a function when differentiated once or twice using either `ForwardDiff` or any [`ChainRules`](https://github.com/JuliaDiff/ChainRules.jl)-compatible AD package, such as `Zygote.jl`. The following features are all implemented in [`NonconvexUtils.jl`](https://github.com/JuliaNonconvex/NonconvexUtils.jl) and re-exported from `Nonconvex`.
1515
16+
## Table of contents
17+
1618
```@contents
1719
Pages = ["user_defined.md", "other_ad.md", "chainrules_fd.md", "sparse.md", "symbolic.md", "implicit.md", "history.md"]
1820
Depth = 3

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Nonconvex.jl Documentation
22

3-
Nonconvex.jl is a Julia package that implements and wraps a number of constrained nonlinear and mixed integer nonlinear programming solvers. There are 4 unique features of Nonconvex.jl compared to similar packages such as JuMP.jl and NLPModels.jl:
3+
Nonconvex.jl is a Julia package that implements and wraps a number of constrained nonlinear and mixed integer nonlinear programming solvers. There are 3 features of Nonconvex.jl compared to similar packages such as JuMP.jl and NLPModels.jl:
44

55
1. Emphasis on a function-based API. Objectives and constraints are normal Julia functions.
66
2. The ability to nest algorithms to create more complicated algorithms.

docs/src/problem/problem.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ There are 3 ways to define a model in Nonconvex.jl:
55
2. `DictModel` which assumes each variable has a name. The decision variables are stored in an `OrderedDict`, an ordered dictionary data structure.
66
3. Start from `JuMP.Model` and convert it to `DictModel`. This is convenient to make use of `JuMP`'s user-friendly macros for variable and linear expression, objective or constraint definitions.
77

8+
## Table of contents
9+
810
```@contents
911
Pages = ["model.md", "dict_model.md", "queries.md"]
1012
Depth = 3

0 commit comments

Comments
 (0)