Skip to content

Commit 948374d

Browse files
ferrolhoHenrique Ferrolho
authored andcommitted
Update docs
1 parent 99ff12b commit 948374d

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

docs/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Navigate to the root of the project with
2+
```bash
3+
cd path/to/TORA.jl
4+
```
5+
6+
To build the docs locally run
7+
```bash
8+
julia --color=yes --project=docs docs/make.jl
9+
```
10+
11+
To serve the docs locally run
12+
```bash
13+
julia -e 'using LiveServer; serve(dir="docs/build")'
14+
```
15+
16+
To serve the docs and update them in real time use
17+
```bash
18+
julia --project=docs -ie 'using TORA, LiveServer; servedocs()'
19+
```

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ makedocs(
77
format = Documenter.HTML(),
88
warnonly = Documenter.except(),
99
sitename = "TORA.jl",
10+
# repo = Remotes.GitHub("JuliaRobotics", "TORA.jl"),
1011
authors = "Henrique Ferrolho",
1112
pages = [
1213
"Home" => "index.md",

docs/src/solver_interfaces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ The *default value* for `use_inv_dyn` is `false`. I.e., the default behaviour is
3535

3636
### Energy Minimization
3737

38-
`minimise_τ=false`
38+
`minimise_torques=false`
3939

4040
By default, problems formulated with TORA.jl are *feasibility problems*.
4141
In other words, the goal for the solver is to find a set of values that satisfies all the constraints of a [`Problem`](@ref).
4242
However, it is possible to define a cost function to be minimized. (Or a value function to be maximized.)
4343

44-
The *default value* for `minimise_τ` is `false`. I.e., the default behaviour is to solve the feasibility problem, without optimizing any objective function. Alternatively, if `minimise_τ` is set to `true`, TORA.jl will minimize the joint torques required by the trajectory being computed.
44+
The *default value* for `minimise_torques` is `false`. I.e., the default behaviour is to solve the feasibility problem, without optimizing any objective function. Alternatively, if `minimise_torques` is set to `true`, TORA.jl will minimize the joint torques required by the trajectory being computed.
4545

4646
!!! warning
4747
Optimizing an objective function is very costly, and may take a significant amount of iterations depending on the [Initial Guess](@ref) provided to the solver.

0 commit comments

Comments
 (0)