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

Extension interferes with other autodoc-skip-member event handlers #35

Closed
timobrembeck opened this issue Mar 1, 2023 · 0 comments · Fixed by #36
Closed

Extension interferes with other autodoc-skip-member event handlers #35

timobrembeck opened this issue Mar 1, 2023 · 0 comments · Fixed by #36
Assignees
Labels

Comments

@timobrembeck
Copy link
Collaborator

Any handler for the autodoc-skip-member signal should return None when the skipping behavior should not be changed:

If more than one enabled extension handles the autodoc-skip-member event, autodoc will use the first non-None value returned by a handler. Handlers should return None to fall back to the skipping behavior of autodoc and other enabled extensions.

At the moment, the value of skip is returned (which is True/False instead of None):

https://github.com/edoburu/sphinxcontrib-django/blob/471f23d3505f74bcff7bb1448781a85a3bc2bf8d/sphinxcontrib_django/docstrings/__init__.py#L147

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant