ImperialCollegeLondon / virtual_ecosystem

This repository is the home for the codebase for the Virtual Ecosystem project.

https://virtual-ecosystem.readthedocs.io

BSD 3-Clause "New" or "Revised" License

9 stars 1 forks source link

Adding automodule hooks for plants model to docs #380

Closed davidorme closed 9 months ago

davidorme commented 9 months ago

Description

This PR adds missing autodoc hooks for the models/plants docstrings.

Fixes #379

Type of change

[ ] New feature (non-breaking change which adds functionality)
[ ] Optimization (back-end change that speeds up the code)
[x] Bug fix (non-breaking change which fixes an issue)

Key checklist

[x] Make sure you've run the pre-commit checks: $ pre-commit run -a
[x] All tests pass: $ poetry run pytest

Further checks

[-] Code is commented, particularly in hard-to-understand areas
[-] Tests added that prove fix is effective or that feature works