You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The AiiDA sphinx extension previously supported just using .. automodule::, by hooking into sphinx.ext.autodoc. This no longer works, as can be seen by this part of the test / demo documentation:
Despite an initial fix in #4470, this issue remains open because currently the directive is written in such a way that it does not allow for the auto-documented objects to be referenced in the same or a similar way as they now can with :py:class: or :py:meth:.
This is because the AiidaProcessDocumenter overwrites their assignment as a class object, but does not similarly store an object on the py domain.
The AiiDA sphinx extension previously supported just using
.. automodule::
, by hooking intosphinx.ext.autodoc
. This no longer works, as can be seen by this part of the test / demo documentation:It should also be checked if there is a way to turn it off. For example https://github.com/lsmo-epfl/aiida-lsmo/blob/develop/docs/source/apidoc/aiida_lsmo.rst currently uses
automodule
, and I'm not sure if the intended behavior is the "regular" class documentation or not.The text was updated successfully, but these errors were encountered: