Skip to content
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.

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

add more sub-headers to sidebar #142

Merged
merged 4 commits into from
Jun 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The `JuliaNonconvex` organization hosts a number of packages which are available

## Design philosophy

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:
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:

1. Emphasis on a function-based API. Objectives and constraints are normal Julia functions.
2. The ability to nest algorithms to create more complicated algorithms.
Expand Down
11 changes: 10 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,16 @@ makedocs(
pages = [
"Getting started" => "index.md",
"Problem definition" => "problem/problem.md",
"Gradients, Jacobians and Hessians" => "gradients/gradients.md",
"Gradients, Jacobians and Hessians" => [
"Overview" => "gradients/gradients.md",
"gradients/user_defined.md",
"gradients/other_ad.md",
"gradients/chainrules_fd.md",
"gradients/sparse.md",
"gradients/symbolic.md",
"gradients/implicit.md",
"gradients/history.md",
],
"Algorithms" => [
"Overview" => "algorithms/algorithms.md",
"algorithms/mma.md",
Expand Down
2 changes: 2 additions & 0 deletions docs/src/gradients/gradients.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ In some cases, function modifiers can even be composed on top of each other to c

> 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`.

## Table of contents

```@contents
Pages = ["user_defined.md", "other_ad.md", "chainrules_fd.md", "sparse.md", "symbolic.md", "implicit.md", "history.md"]
Depth = 3
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nonconvex.jl Documentation

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:
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:

1. Emphasis on a function-based API. Objectives and constraints are normal Julia functions.
2. The ability to nest algorithms to create more complicated algorithms.
Expand Down
2 changes: 2 additions & 0 deletions docs/src/problem/problem.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ There are 3 ways to define a model in Nonconvex.jl:
2. `DictModel` which assumes each variable has a name. The decision variables are stored in an `OrderedDict`, an ordered dictionary data structure.
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.

## Table of contents

```@contents
Pages = ["model.md", "dict_model.md", "queries.md"]
Depth = 3
Expand Down