Fix #10058: Autosummary excludes stuff from its table if autodoc_class_signature='separated'.
#10060
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
January 7, 2022 22:28
Pass the `autosummary_imported_members` config var into Documenter.options.imported_members, so we don't miss members from autosummary tables.
|
Is this related to |
Ah, sorry. Now I understand this bug. It is consist of two bugs. One is an imported object is shown even if I'll start to review this again from now on. |
|
Note:
|
|
Merged #10085 instead. Thank you for your contribution! |
|
thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Fix #10058: Autosummary excludes stuff from its table if
autodoc_class_signature='separated'.Feature or Bugfix
Purpose
When using autosummary with
autodoc_class_signature= 'separated', it won't include any Classes in its summary table, even if you explicitly ask for them.This seems to be because when this method is set, the ClassDocumenter gets its
options.membersset to['__new__', '__init__']; it seems to be alwaysNone/[]in other cases. So I think thecheck_module()check (ext/autosummary/__init__.py:376) has never really been working properly, but it hasn't mattered becauseoptions.membersis normally falsy in most situations.The included test shows the broken behaviour pretty clearly, the fix commit seems to make sense to me but I'm not familiar with Sphinx source code, maybe there's a better fix.