Skip to content

Commit

Permalink
Fix the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amontoison committed Mar 27, 2023
1 parent 0092d43 commit bfa67da
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 18 deletions.
6 changes: 2 additions & 4 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
[deps]
CUTEst = "1b53aba6-35b6-5f92-a507-53c67d53f819"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
NLPModels = "a4795742-8479-5a88-8948-cc11e1c8c1a6"

[compat]
Documenter = "~0.26"
Krylov = "0.8"
NLPModels = "0.19"
Documenter = "0.27"
NLPModels = "0.20"
10 changes: 4 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ makedocs(
doctest = true,
linkcheck = true,
strict = true,
assets = ["assets/style.css"],
format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
format = Documenter.HTML(assets = ["assets/style.css"],
ansicolor = true,
prettyurls = get(ENV, "CI", nothing) == "true"),
sitename = "CUTEst.jl",
pages = Any[
pages = [
"Home" => "index.md",
"Tutorial" => "tutorial.md",
"Core" => "core.md",
Expand All @@ -17,10 +18,7 @@ makedocs(
)

deploydocs(
deps = nothing,
make = nothing,
repo = "github.com/JuliaSmoothOptimizers/CUTEst.jl.git",
target = "build",
devbranch = "main",
push_preview = true,
)
12 changes: 6 additions & 6 deletions docs/src/reference.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Reference

## Contents

```@contents
Pages = ["reference.md"]
```

## Index

```@index
Pages = ["reference.md"]
```

```@autodocs
Modules = [CUTEst]
```
```
2 changes: 1 addition & 1 deletion docs/src/tutorial.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
You can check an [Introduction to CUTEst.jl](https://jso-docs.github.io/introduction-to-cutest/) on our site, [jso-docs](https://jso-docs.github.io).
You can check an [Introduction to CUTEst.jl](https://juliasmoothoptimizers.github.io/tutorials/introduction-to-cutest/) on our [site](https://juliasmoothoptimizers.github.io/).
2 changes: 1 addition & 1 deletion src/classification.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ old CUTEst installation, it can lead to inconsistencies.
- `only_*` flags are self-explaining. Note that they appear in conflicting
pairs. Both can be false, but only one can be true.
- `objtype` is the classification of the objective function according to the
[MASTSIF classification file](http://www.cuter.rl.ac.uk//Problems/classification.shtml).
[MASTSIF classification file](https://www.cuter.rl.ac.uk/Problems/classification.shtml).
It can be a number, a symbol, a string, or an array of those.
1, :none or "none" means there is no objective function;
Expand Down

0 comments on commit bfa67da

Please sign in to comment.