Skip to content

Commit

Permalink
foo
Browse files Browse the repository at this point in the history
  • Loading branch information
ocots committed Jul 27, 2023
1 parent 0cc71e0 commit 4428cdd
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 7 deletions.
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
[deps]
CTBase = "54762871-cc72-4466-b8e8-f6c8b58076cd"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
4 changes: 4 additions & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
using Documenter
using CTDirect
using CTBase

DocMeta.setdocmeta!(CTBase, :DocTestSetup, :(using CTBase); recursive = true)
DocMeta.setdocmeta!(CTDirect, :DocTestSetup, :(using CTDirect); recursive = true)

makedocs(
sitename = "CTDirect.jl",
Expand Down
21 changes: 21 additions & 0 deletions docs/src/api-ctbase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# CTBase API

This is just a dump of CTBase API documentation.
For more details about `CTBase.jl` package, see the [documentation](https://control-toolbox.org/docs/ctbase).

## Index

```@index
Pages = ["api-ctbase.md"]
Modules = [CTBase]
Order = [:module, :constant, :type, :function, :macro]
Private = false
```

## Documentation

```@autodocs
Modules = [CTBase]
Order = [:module, :constant, :type, :function, :macro]
Private = false
```
16 changes: 9 additions & 7 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,15 @@ LB \le C(X) \le UB

We use packages from [JuliaSmoothOptimizers](https://github.com/JuliaSmoothOptimizers) to solve the (NLP) problem.

As input of this package we use an [`OptimalControlModel`](@ref) structure from CTBase.

As input of this package we use an [`OptimalControlModel`](@ref) structure from CTBase
!!! note " Actual limitation"
For the moment we have implemented
- Only trapezoidal rule for the discretization
- Only Ipopt for the optimization soltware
!!! note "Current limitations"

!!! note "Link with bocop"
For the moment we have only implemented

This package is equivalent to the [bocop](https://bocop.org) software
- trapezoidal rule for the discretization
- `Ipopt` for the optimization software

!!! note "Related packages"

This package is equivalent to the [bocop](https://www.bocop.org) software.

0 comments on commit 4428cdd

Please sign in to comment.