search

Deltares / Ribasim

Water resources modeling
https://deltares.github.io/Ribasim/
MIT License
36 stars 5 forks source link

Auto-generate framework for Python API reference documentation #1565

Closed Jingru923 closed 1 week ago

Jingru923 commented 1 week ago

Part of #1439 .

I added the public functions (the one that doesn't start with a "_") to the documentation. Give some short description on some of them.

Jingru923 commented 1 week ago

My new commit allow us to have a nice framework for API reference. All the classes and their functions are included.

quartodoc also display all the docstring that are in the classes and functions. However, at the moment there are not that many of docstrings.

To have more text in the API, I suggest that we create a new issue for it.