Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for autoexception directive #48

Open
andy-maier opened this issue Apr 18, 2021 · 0 comments
Open

Add support for autoexception directive #48

andy-maier opened this issue Apr 18, 2021 · 0 comments

Comments

@andy-maier
Copy link

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.

@andy-maier andy-maier changed the title Add support for auto Add support for autoexception directive Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant