Proper documentation for new python bindings

[IshaanDesai]

The refactored python bindings and underlying new bindings need documentation explaining the API functions and also some basic explanation of cython working

[IshaanDesai]

Doxygen-style documentation of the new python bindings can be found here. This is a pilot for doxygen documentation for bindings and eventually all bindings can be documented in a similar way.

[MakisH]

Could you please open a (draft) Pull Request? It is easier to track and discuss the changes there. :)

[BenjaminRodenberg]

related PR is here: precice/precice#450

[IshaanDesai]

The main problem of doxygen documentation for these bindings is that doxygen does not support cython as a standard language in its documentation toolbox. More explanation here. As mentioned here in the official doxygen repo, I have asked the main developer if it is possible to add cython as a supported language to doxygen. Until this point no other workaround has been found.

[ajaust]

I would support adding more information about the Python interface. Especially the new bindings (precice_future) differ quite a lot from the previous bindings and also a lot from the C++ API (Example: set_mesh_vertex has only 3 arguments and returns the vertex list/vector). I could not find information about the actual Python API in the wiki nor the project page (https://github.com/precice/precice/tree/doxygen_pythonbindings/src/precice/bindings/python_future). It is mainly about the installation/compilation of the bindings.

Maybe a reference/note to look into precice_future.pyx would be already enough?

This is also related to precice/precice#450 I guess.

[IshaanDesai]

Related PR is now in the new python-bindings repo: #10