Skip to content

Commit b601132

Browse files
committed
Update APIs, bump version
1 parent c633270 commit b601132

9 files changed

Lines changed: 42 additions & 13 deletions

File tree

Project.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "VPLDocs"
22
uuid = "19246b20-85cd-4f94-a989-28bb6828320f"
33
authors = ["Alejandro Morales Sierra <alejandro.moralessierra@wur.nl> and contributors"]
4-
version = "0.0.4"
4+
version = "0.0.5"
55

66
[deps]
77
Ecophys = "19467474-d12d-47c9-939f-3e50fbfd93ad"
@@ -18,8 +18,8 @@ Ecophys = "0.1.0"
1818
PlantGeomPrimitives = "0.0.2"
1919
PlantGeomTurtle = "0.0.3"
2020
PlantGraphs = "0.0.2"
21-
PlantRayTracer = "0.0.4"
21+
PlantRayTracer = "0.0.5"
2222
PlantSimEngine = "0.9"
23-
PlantViz = "0.0.4"
24-
SkyDomes = "0.1.3"
23+
PlantViz = "0.0.5"
24+
SkyDomes = "0.1.4"
2525
julia = "1.9"

docs/make.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
using VPLDocs
22
using Documenter
33
import PlantGraphs, PlantGeomPrimitives, PlantGeomTurtle, PlantRayTracer, PlantViz, SkyDomes, Ecophys, PlantSimEngine
4+
import Ecophys.Photosynthesis, Ecophys.Growth
45

56
makedocs(;
67
doctest = false,
7-
modules = [VPLDocs, PlantGraphs, PlantGeomPrimitives, PlantGeomTurtle, PlantRayTracer, PlantViz, SkyDomes, Ecophys, PlantSimEngine],
8+
modules = [VPLDocs, PlantGraphs, PlantGeomPrimitives, PlantGeomTurtle, PlantRayTracer,
9+
PlantViz, SkyDomes, Ecophys.Photosynthesis, Ecophys.Growth, PlantSimEngine],
810
authors="Alejandro Morales <alejandro.moralessierra@wur.nl> and contributors",
911
repo="https://github.com/VirtualPlantLab/VPLDocs/blob/{commit}{path}#{line}",
1012
sitename="Virtual Plant Laboratory",
@@ -57,7 +59,8 @@ makedocs(;
5759
],
5860
"Ecophys" => [
5961
"Ecophys package" => "VPLVerse/Ecophys/index.md",
60-
"Photosynthesis API" => "VPLVerse/Ecophys/photosynthesis.md"
62+
"Photosynthesis API" => "VPLVerse/Ecophys/photosynthesis.md",
63+
"Growth API" => "VPLVerse/Ecophys/growth.md"
6164
],
6265
"PlantSimEngine" => [
6366
"PlantSimEngine package" => "VPLVerse/PlantSimEngine/index.md"
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Growth
2+
3+
```@meta
4+
CurrentModule = Ecophys.Growth
5+
```
6+
7+
## Public API
8+
9+
```@autodocs
10+
Modules = [Growth]
11+
Public = true
12+
Private = false
13+
```
14+
15+
## Private
16+
17+
Private functions, types or constants from `Growth`. These are not exported, so you need to prefix the function name with `Ecophys.Growth` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
18+
19+
```@autodocs
20+
Modules = [Growth]
21+
Public = false
22+
Private = true
23+
```

docs/src/VPLVerse/Ecophys/photosynthesis.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Photosynthesis
32

43
```@meta
@@ -15,7 +14,7 @@ Private = false
1514

1615
## Private
1716

18-
Private functions, types or constants from `Photosynthesis`. These are not exported, so you need to prefix the function name with `PlantGeomPrimitives.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
17+
Private functions, types or constants from `Photosynthesis`. These are not exported, so you need to prefix the function name with `Ecophys.Photosynthesis` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
1918

2019
```@autodocs
2120
Modules = [Photosynthesis]

docs/src/VPLVerse/SkyDomes/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Private = false
2323

2424
## Private
2525

26-
Private functions, types or constants from `SkyDomes`. These are not exported, so you need to prefix the function name with `PlantGeomPrimitives.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
26+
Private functions, types or constants from `SkyDomes`. These are not exported, so you need to prefix the function name with `SkyDomes.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
2727

2828
```@autodocs
2929
Modules = [SkyDomes]

docs/src/api/graphs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Private = false
1717

1818
## Private
1919

20-
Private functions, types or constants from `PlantGraphs`. These are not exported, so you need to prefix the function name with `PlantGeomPrimitives.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
20+
Private functions, types or constants from `PlantGraphs`. These are not exported, so you need to prefix the function name with `PlantGraphs.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
2121

2222
```@autodocs
2323
Modules = [PlantGraphs]

docs/src/api/raytracer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Private = false
1414

1515
## Private
1616

17-
Private functions, types or constants from `PlantRayTracer`. These are not exported, so you need to prefix the function name with `PlantGeomPrimitives.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
17+
Private functions, types or constants from `PlantRayTracer`. These are not exported, so you need to prefix the function name with `PlantRayTracer.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
1818

1919
```@autodocs
2020
Modules = [PlantRayTracer]

docs/src/api/turtle.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Private = false
1515

1616
## Private
1717

18-
Private functions, types or constants from `PlantGeomTurtle`. These are not exported, so you need to prefix the function name with `PlantGeomPrimitives.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
18+
Private functions, types or constants from `PlantGeomTurtle`. These are not exported, so you
19+
need to prefix the function name with `PlantGeomTurtle.` to access them. Also bear in mind
20+
that these are not part of the public API, so they may change without notice.
1921

2022
```@autodocs
2123
Modules = [PlantGeomTurtle]

docs/src/api/viz.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ Private = false
1414

1515
## Private
1616

17-
Private functions, types or constants from `PlantViz`. These are not exported, so you need to prefix the function name with `PlantGeomPrimitives.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
17+
Private functions, types or constants from `PlantViz`. These are not exported, so you need
18+
to prefix the function name with `PlantViz.` to access them. Also bear in mind that these
19+
are not part of the public API, so they may change without notice.
1820

1921
```@autodocs
2022
Modules = [PlantViz]

0 commit comments

Comments
 (0)