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

autosummary should ignore imported members #1654

Closed
shimizukawa opened this issue Jan 3, 2015 · 2 comments
Closed

autosummary should ignore imported members #1654

shimizukawa opened this issue Jan 3, 2015 · 2 comments

Comments

@shimizukawa
Copy link
Member

When I have and autosummary directive with :toctree: (and autosummary_generate = True), then the stub files generated by autodoc also list all imported members. I don't want that. Because it is the opposite of what plain autodoc does (http://sphinx-doc.org/latest/ext/autodoc.html). And it broke my build due to warnings in imported docstrings.

Here is a small patch against the current development version which calls ModuleDocumenter.check_import() and therefore causes the summary table to not list imported members.

With plain autodoc there is a flag "imported-members", but I am not sure whether autosummary respects this option (didn't verify)


@shimizukawa
Copy link
Member Author

From Takayuki Shimizukawa on 2014-12-19 03:41:29+00:00

Duplicate of #1061.

@shimizukawa
Copy link
Member Author

From Takayuki Shimizukawa on 2014-12-19 03:42:19+00:00

Thanks for the patch. It's useful.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant