People-Places-Solutions / floodmodeller-api

The Flood Modeller Python API is a free and open-source python package which provides a bridge between Flood Modeller and the python programming language to extend the capabilities of Flood Modeller in automated workflows
https://api.floodmodeller.com/api/
Other
38 stars 15 forks source link

TUFLOW HPC linked models in LF1 #101

Closed scleakey closed 6 months ago

scleakey commented 7 months ago
joe-pierce commented 7 months ago

Thanks Shannon - before I merge can you add something extra to the docs to show this in an example, and update the docstrings that are used in the docs: https://api.floodmodeller.com/api/user_guide/lf.html

scleakey commented 7 months ago

@joe-pierce can you add test (3.12) to the list of required checks to pass to be merged to main? currently just 3.9, 3.10, 3.11

scleakey commented 6 months ago

@joe-pierce I updated the documentation as requested. I also added sphinx to the contributing guidelines and requirements.txt, which required updating from sphinx-panels to sphinx-design. I also added sphinx to github actions as it was picking up a few important docstring formatting errors.