Chilipp / autodocsumm

Extending your autodoc API docs with a summary
Apache License 2.0
48 stars 14 forks source link

Add support for autoexception directive #48

Open andy-maier opened 3 years ago

andy-maier commented 3 years ago

The Sphinx autodoc extension supports a directive autoexception (https://documentation.help/Sphinx/autodoc.html#directive-autoexception).

Specifying :autosummary: on the autoexception directive fails:

.../docs/client/exceptions.rst:49: WARNING: An option to autoexception is either unknown or has an invalid value: 'autosummary'

For consistency, it would be great to enable its use. I believe the autoexception directive behaves pretty much the same as the autoclass directive, but I did not dig deep into this. The autodoc documentation is not very specific about it, unfortunately.