BUG: autosummary to list all class members #4247
Merged
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
This was referenced Nov 17, 2017
|
Any comments in this PR? |
|
@shimizukawa could you review this please? |
|
Any update on this? |
|
Sorry for very late reviewing. |
|
Thanks for reviewing and merging! |
This was referenced Mar 27, 2019
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.
Fixes the availability of the list of attributes in the autosummary template.
Feature or Bugfix
Purpose
This PR intends to be a more general fix for b3e0e29. That commit fixed issue #3900 for the methods being no longer available in the autosummary template. This generalizes that so also the Attributes are again available in the autosummary template.
The fact that those methods/attributes are no longer available is/was a regression in the 1.6.x line.
Detail
The rationale of the fix is that the "imported_members=False" (which is the default) is not relevant for a class, but only for a module. Therefore I removed this in the
elif doc.objtype == 'class':branch.Relates
methodsmissing in Sphinx 1.6 #3900