Skip to content

Build docs with PlantSimEngine 0.15 and PlantBiophysics 0.18 #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
VEZY wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Build docs with PlantSimEngine 0.15 and PlantBiophysics 0.18 #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6602887
Build API docs with PlantSimEngine 0.15 and PlantBiophysics 0.18
VEZY Sep 21, 2026
c1eb0d4
Align workspace dependency bounds with the docs environment
VEZY Sep 21, 2026
39d8dd6
Include PlantSimEngine namespaces and private example API docs
VEZY Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ VirtualPlantLab = "b977ecfa-1b9a-418d-909d-4ebe565736ce"

[compat]
Ecophys = "0.1.1"
PlantBiophysics = "0.17.0"
PlantBiophysics = "0.18.0"
PlantGeomPrimitives = "1.0.3"
PlantGeomTurtle = "1.0.1"
PlantGraphs = "1.0.0"
PlantRayTracer = "1.0.1"
PlantSimEngine = "0.14.1"
PlantSimEngine = "0.15.0"
PlantViz = "1.0.1"
SkyDomes = "1.0.1"
VirtualPlantLab = "1.0.2"
Expand Down
4 changes: 4 additions & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ PlantRayTracer = "78485975-e4aa-407d-b3bb-ded5a4265d05"
PlantSimEngine = "9a576370-710b-4269-adf9-4f603a9c6423"
PlantViz = "358bd95d-d12c-439f-94b7-04b17e500c7f"
SkyDomes = "1838625c-7cf7-40c6-898b-904883e4b556"

[compat]
PlantBiophysics = "0.18.0"
PlantSimEngine = "0.15.0"
17 changes: 13 additions & 4 deletions docs/src/VPLVerse/PlantSimEngine/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ CurrentModule = PlantSimEngine

```@index
Modules = [PlantSimEngine]
Public = true
Private = true
```

## Public API
Expand All @@ -21,6 +19,17 @@ Public = true
Private = false
```

### Namespaces

```@docs
PlantSimEngine.Advanced
PlantSimEngine.GraphEditor
PlantSimEngine.EnvironmentAPI
PlantSimEngine.Evaluation
PlantSimEngine.Authoring
PlantSimEngine.Diagnostics
```

## Examples

```@autodocs
Expand All @@ -31,10 +40,10 @@ Private = false

## Private

Private functions, types or constants from `PlantSimEngine`. These are not exported, so you need to prefix the function name with `PlantSimEngine.` to access them. Also bear in mind that these are not part of the public API, so they may change without notice.
Private functions, types or constants from `PlantSimEngine` and `PlantSimEngine.Examples`. These are not exported, so you need to prefix their names with the corresponding module to access them. Also bear in mind that these are not part of the public API, so they may change without notice.

```@autodocs
Modules = [PlantSimEngine]
Modules = [PlantSimEngine, PlantSimEngine.Examples]
Public = false
Private = true
```
Loading