Close #4257: autodoc: Add autodoc_class_signature #9171
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
tk0miya
added
type:enhancement
tk0miya
commented
May 5, 2021
tk0miya
force-pushed
the
4257_autodoc_class_signature
branch
3 times, most recently
from
fb3f3e0
to
59b2830
Compare
tk0miya
force-pushed
the
4257_autodoc_class_signature
branch
3 times, most recently
from
db60c7b
to
7f16b82
Compare
Add `autodoc_class_signature` to separate the class entry and the definition of `__init__()` method.
tk0miya
force-pushed
the
4257_autodoc_class_signature
branch
from
7f16b82
to
51ae283
Compare
RuRo
reviewed
Jul 23, 2021
| if self.options.special_members is None: | ||
| self.options['special-members'] = {'__new__', '__init__'} | ||
| else: | ||
| self.options.special_members.append('__new__') |
There was a problem hiding this comment.
Did you mean .add instead of .append here and in class _All? I tried to build my project documentation with the new autodoc_class_signature option (sphinx installed from github master) and got
# ... snip ...
File "/home/ruro/projects/personal/aside/.venv/lib/python3.6/site-packages/sphinx/ext/autodoc/directive.py", line 162, in run
documenter.generate(more_content=self.content)
File "/home/ruro/projects/personal/aside/.venv/lib/python3.6/site-packages/sphinx/ext/autodoc/__init__.py", line 976, in generate
self.document_members(all_members)
File "/home/ruro/projects/personal/aside/.venv/lib/python3.6/site-packages/sphinx/ext/autodoc/__init__.py", line 850, in document_members
documenter = classes[-1](self.directive, full_mname, self.indent)
File "/home/ruro/projects/personal/aside/.venv/lib/python3.6/site-packages/sphinx/ext/autodoc/__init__.py", line 1452, in __init__
self.options.special_members.append('__new__')
AttributeError: 'set' object has no attribute 'append'There was a problem hiding this comment.
Oops... you're right. Could you file an issue or pull request, please?
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.
Feature or Bugfix
Purpose
autodoc_class_signatureto separate the class entry and thedefinition of
__init__()method.autoclass#4257