atmtools / arts

The Atmospheric Radiative Transfer Simulator
https://www.radiativetransfer.org/
Other
62 stars 28 forks source link

Auto-generated documentation did not work, so now we make it explicitly #819

Closed riclarsson closed 1 week ago

riclarsson commented 1 week ago

This should fix the documentation for pyarts.arts.

Nanobind types such as nb_func are not really functions. Sphinx creates the documentation using autoattributes instead of automethod. The latter works, so this creates a big problem in the documentation string.

Now we loop over all pyarts.arts objects and generate this documentation with more manual efforts. Still, we rely on automethod and others for most of the work.

This does not generate the pyarts.workspace.Workspace documentation, so there is still some work to do to fix the documentation.