Skip to content

Commit

Permalink
update API reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesknight committed Dec 16, 2024
1 parent 9962b43 commit 05be816
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
16 changes: 5 additions & 11 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,8 @@ To run GLM, you will either need to source a pre-compiled binary or [compile GLM

The following table lists the GLM version that is bundled with the built distribution of each glm-py release:

[glm_py_0_1_3]: https://github.com/AquaticEcoDynamics/glm-py/releases/tag/v0.1.3
[glm_py_0_2_0]: https://github.com/AquaticEcoDynamics/glm-py/releases/tag/v0.2.0
[glm_py_0_2_1]: https://github.com/AquaticEcoDynamics/glm-py/releases/tag/v0.2.1
[glm_py_0_3_1]: https://github.com/AquaticEcoDynamics/glm-py/releases/tag/v0.3.1

| glm-py version | GLM version |
| -------------- | ----------- |
| [`0.3.1`][glm_py_0_3_1] | `3.3.1a12 ` |
| [`0.2.1`][glm_py_0_2_1] | `3.3.1a12 ` |
| [`0.2.0`][glm_py_0_2_0] | `3.3.1a12 ` |
| [`0.1.3`][glm_py_0_1_3] | `3.3.1a12 ` |
| glm-py version | GLM version |
| -------------- | ----------- |
| `0.3.*` | `3.3.1a12 ` |
| `0.2.*` | `3.3.1a12 ` |
| `0.1.*` | `3.3.1a12 ` |
1 change: 1 addition & 0 deletions docs/plots.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: glmpy.plots
1 change: 1 addition & 0 deletions docs/sparkling.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: glmpy.example_sims.sparkling
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,15 @@ nav:
- GLM JSON: how_to/how-to-glm_json.md
- API Reference:
- NML: nml.md
- Dimensions: dimensions.md
- GLM_JSON: json-to-nml.md
- Simulation: simulation.md
- Plots: plots.md
- Dimensions: dimensions.md
- Inflows: inflows.md
- Outflows: outflows.md
- GLM_JSON: json-to-nml.md
- Example sims:
- Sparkling: sparkling.md

- Contributing:
- contributing/index.md
- Blog:
Expand Down

0 comments on commit 05be816

Please sign in to comment.