Python reference docs are almost empty

[visr]

https://deltares.github.io/Ribasim/reference/python/
Could be due to changes in https://github.com/machow/quartodoc

Possibly related to #219

Edit: I think it is working fine, but we just don't have many docstrings anymore. And currently methods that have docstrings don't seems to get included, so we should look into that. Perhaps best done after #1298.

• Fix bug in docstrings
• add info to pages (focus on most important items:

[Jingru923]

I added some docstring under Model() class, and quartodoc can show those docstring now, the bug is no longer there.

[Jingru923]

When I was working on this issue, I hope that quardoc can collect all the self-defined functions in Model class and show it in API.

I tried include_functions option in content, it does nothing. This turns out to be impossible.

My current conclusion is that we need to list all the functions manually, and later if new functions are added, keep in mind to also add them to API page. I think we can generate a list of functions in python, and copy paste that list to quartodoc in _quarto.yml. I couldn't succeed it yet but I believe we can investigate that

[evetion]

It might be good to link to an open issue on quartodoc about this, and link to the configuration page, where you got the include_functions from.

[evetion]

FWIW, after checking the documentation, and this issue, we could do this:

quartodoc:
  style: pkgdown
  dir: python/reference
  title: API Reference
  package: ribasim
  options:
      include_inherited: true
      include_empty: true
      include_attributes: true
      include_classes: true
      include_functions: true
  sections:
    - title: ribasim
      contents:
        - name: ribasim
          package: null
          include_imports: true

The options will make sure to render everything (classes/attributes/etc), while the ribasim section would render everything we export.

[Jingru923]

Thanks for the input @evetion

What you put in the sections should be modules in ribasim otherwise you get error Cannot find an object named: ribasim. Does an object with the path ribasim:ribasim exist

However, if I remove lines after sections, specifying options in this way seems working! Now we have a not-empty-at-all API

[Jingru923]

Continue work of this issue is here #1571

This issue thus can be closed