I'm working on a code base that often defines methods (both class and instance) on exceptions. The class methods are used to construct the exception from other data (often other underlying exceptions), and the instance methods are used to format the exceptions for reporting to external systems.
It looks like sphinx-automodapi doesn't generate method information for exceptions, and I didn't see any documented way to enable this. For example, an exception class with a to_slack instance method and a from_exception class method generates only:
SlackWebException
=================
.. currentmodule:: safir.slack.blockkit
.. autoexception:: SlackWebException
I was hoping there would be some way to enable the normal sort of class documentation, such as:
SlackWebException
=================
.. currentmodule:: safir.slack.blockkit
.. autoexception:: SlackWebException
.. rubric:: Methods Summary
.. autosummary::
~SlackWebException.from_exception
~SlackWebException.to_slack
.. rubric:: Methods Documentation
.. automethod:: from_exception
.. automethod:: to_slack
I'm working on a code base that often defines methods (both class and instance) on exceptions. The class methods are used to construct the exception from other data (often other underlying exceptions), and the instance methods are used to format the exceptions for reporting to external systems.
It looks like sphinx-automodapi doesn't generate method information for exceptions, and I didn't see any documented way to enable this. For example, an exception class with a
to_slackinstance method and afrom_exceptionclass method generates only:I was hoping there would be some way to enable the normal sort of class documentation, such as: