Skip to content

Commit 2832e6c

Browse files
committed
Add Documenter docu
1 parent 65d8336 commit 2832e6c

File tree

7 files changed

+133
-0
lines changed

7 files changed

+133
-0
lines changed

docs/Project.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
KiteUtils = "90980105-b163-44e5-ba9f-8b1c83bb0533"
4+
5+
[compat]
6+
julia = "1.10, 1.11"
7+
KiteUtils = "0.7, 0.8, 0.9, 0.10"
8+
Documenter = "0.27"
9+
10+

docs/make.jl

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
using WinchControllers
2+
using Documenter
3+
4+
# DocMeta.setdocmeta!(WinchControllers, :DocTestSetup; recursive=true)
5+
6+
makedocs(;
7+
modules=[WinchControllers],
8+
authors="Uwe Fechner <[email protected]>",
9+
repo="https://github.com/aenarete/KiteModels.jl/blob/{commit}{path}#{line}",
10+
sitename="WinchControllers.jl",
11+
format=Documenter.HTML(;
12+
prettyurls=get(ENV, "CI", "false") == "true",
13+
canonical="https://aenarete.github.io/WinchControllers.jl",
14+
assets=String[],
15+
),
16+
pages=[
17+
"Home" => "index.md",
18+
"Types" => "types.md",
19+
"Functions" => "functions.md"
20+
],
21+
)
22+
23+
deploydocs(;
24+
repo="github.com/aenarete/WinchControllers.jl",
25+
devbranch="main",
26+
)

docs/src/functions.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
```@meta
2+
CurrentModule = WinchControllers
3+
```
4+
## Input functions
5+
```@docs
6+
set_vset_pc
7+
```
8+
9+
## Output functions
10+
```@docs
11+
calc_output
12+
calc_vro
13+
get_state
14+
```
15+
16+
## Utility functions
17+
```@docs
18+
@limit
19+
saturate
20+
merge_angles
21+
```

docs/src/index.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
```@meta
2+
CurrentModule = WinchControllers
3+
```
4+
5+
# WinchControllers
6+
Documentation for the package [WinchControllers](https://github.com/aenarete/WinchControllers.jl).
7+
8+
This package is part of Julia Kite Power Tools, which consist of the following packages:
9+
10+
![Julia Kite Power Tools](kite_power_tools.png)
11+
12+
## Installation
13+
Install [Julia 1.10](https://ufechner7.github.io/2024/08/09/installing-julia-with-juliaup.html) or later, if you haven't already. On Linux, make sure that Python3 and Matplotlib are installed:
14+
```
15+
sudo apt install python3-matplotlib
16+
```
17+
Before installing this software it is suggested to create a new project, for example like this:
18+
```bash
19+
mkdir test
20+
cd test
21+
julia --project="."
22+
```
23+
Then add WinchControllers from Julia's package manager, by typing:
24+
```julia
25+
using Pkg
26+
pkg"add WinchControllers"
27+
```
28+
at the Julia prompt. You can run the unit tests with the command (careful, can take 60 min):
29+
```julia
30+
pkg"test WinchControllers"
31+
```
32+
33+
## Provides
34+
35+
## See also
36+
- [Research Fechner](https://research.tudelft.nl/en/publications/?search=Fechner+wind&pageSize=50&ordering=rating&descending=true) for the scientic background of this code
37+
- The meta-package [KiteSimulators](https://github.com/aenarete/KiteSimulators.jl)
38+
- the package [KiteUtils](https://github.com/ufechner7/KiteUtils.jl)
39+
- the packages [WinchModels](https://github.com/aenarete/WinchModels.jl) and [KitePodModels](https://github.com/aenarete/KitePodModels.jl) and [AtmosphericModels](https://github.com/aenarete/AtmosphericModels.jl)
40+
- the packages [KiteControllers](https://github.com/aenarete/KiteControllers.jl) and [KiteViewers](https://github.com/aenarete/KiteViewers.jl)
41+
42+
Author: Uwe Fechner ([email protected])

docs/src/kite_power_tools.png

50.9 KB
Loading

docs/src/types.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Exported Types
2+
3+
```@meta
4+
CurrentModule = WinchControllers
5+
```
6+
7+
## Basic types
8+
```@docs
9+
WCSettings
10+
```

scripts/build_docu.jl

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# build and display the html documentation locally
2+
# you must have installed the package LiveServer in your global environment
3+
4+
using Pkg
5+
6+
function globaldependencies()
7+
projectpath = Pkg.project().path
8+
basepath, _ = splitdir(projectpath)
9+
Pkg.activate()
10+
globaldependencies = keys(Pkg.project().dependencies)
11+
Pkg.activate(basepath)
12+
globaldependencies
13+
end
14+
15+
if !("LiveServer" in globaldependencies())
16+
println("Installing LiveServer globally!")
17+
run(`julia -e 'using Pkg; Pkg.add("LiveServer")'`)
18+
end
19+
20+
if !("Documenter" keys(Pkg.project().dependencies))
21+
using TestEnv
22+
TestEnv.activate()
23+
end
24+
using LiveServer; servedocs(launch_browser=true)

0 commit comments

Comments
 (0)