Skip to content

Documentation: use autosummary

Right now, the documentation is using docstring to be generated thanks to autodoc. However, a reference to each function have to be put in the body of the documentation.

In the past, a first attempt has already been done to use autosummary, but it was detecting and generating documentation for the "private" interface.

The objective would be to generate a correct documentation without this "private" API.

Edited by Baptiste Esteban