Skip to content

Commit

Permalink
fix(docs/reference): removed previous references (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
Carsopre authored Apr 13, 2022
1 parent d160d8d commit 70e9944
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 11 deletions.
1 change: 1 addition & 0 deletions docs/guides/run_simulation_veg.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# How to run a Vegetation simulation in NBSDynamics

An example of how a simulation is run can be found in the [acceptance tests](../../test/test_acceptance.py#TestAcceptance::test_given_veg_case_runs)

## Simulation structure.

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/biota_models/coral/coral_model.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Coral models for the NBSDynamics package.

### Coral Protocol
::: src.core.coral.coral_protocol
::: src.biota_models.coral.model.coral_protocol

### Coral model
::: src.core.coral.coral_model
::: src.biota_models.coral.model.coral_model

## Coral Constants
::: src.core.coral.coral_constants
::: src.biota_models.coral.model.coral_constants

## Coral utils
::: src.core.coral.coral_morphology
::: src.core.coral.coral_only
::: src.biota_models.coral.model.coral_morphology
::: src.biota_models.coral.model.coral_only
4 changes: 2 additions & 2 deletions docs/reference/biota_models/coral/coral_output.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Output classes for the NBSDynamics coral model.

### Wrapper
::: src.core.output.coral_output_wrapper
::: src.biota_models.coral.output.coral_output_wrapper

### Output models
::: src.core.output.coral_output_model
::: src.biota_models.coral.output.coral_output_model
4 changes: 2 additions & 2 deletions docs/reference/biota_models/vegetation/vegetation_output.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Output classes for the NBSDynamics vegetation model.

### Wrapper
::: src.core.output.veg_output_wrapper
::: src.biota_models.vegetation.output.veg_output_wrapper

### Output models
::: src.core.output.veg_output_model
::: src.biota_models.vegetation.output.veg_output_model
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Classes representing the available simulation modes.

### Base simulation.
::: src.core.simulation.veg_base_simulation
::: src.biota_models.vegetation.simulation.veg_base_simulation

### Vegetation Delft3D (FlowFM / DIMR)
::: src.core.simulation.veg_delft3d_simulation
::: src.biota_models.vegetation.simulation.veg_delft3d_simulation

0 comments on commit 70e9944

Please sign in to comment.