IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9182 from tk0miya/refactor_autodoc

Browse Source 
refactor: autodoc: Remove backslashes from the tail of line
This commit is contained in:
Takeshi KOMIYA 2021-05-10 01:50:15 +09:00 committed by GitHub
commit b88187de34
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
sphinx/ext/autodoc/__init__.py
View File

@ -389,8 +389,8 @@ class Documenter:
# functions can contain a signature which is then used instead of # functions can contain a signature which is then used instead of
# an autogenerated one # an autogenerated one
try: try:
explicit_modname, path, base, args, retann = \ matched = py_ext_sig_re.match(self.name)
py_ext_sig_re.match(self.name).groups() explicit_modname, path, base, args, retann = matched.groups()
except AttributeError: except AttributeError:
logger.warning(__('invalid signature for auto%s (%r)') % (self.objtype, self.name), logger.warning(__('invalid signature for auto%s (%r)') % (self.objtype, self.name),
type='autodoc') type='autodoc')
@ -412,8 +412,8 @@ class Documenter:
self.args = args self.args = args
self.retann = retann self.retann = retann
self.fullname = (self.modname or '') + \ self.fullname = ((self.modname or '') +
('.' + '.'.join(self.objpath) if self.objpath else '') ('.' + '.'.join(self.objpath) if self.objpath else ''))
return True return True
def import_object(self, raiseerror: bool = False) -> bool: def import_object(self, raiseerror: bool = False) -> bool:
@ -825,8 +825,9 @@ class Documenter:
if self.objpath: if self.objpath:
self.env.temp_data['autodoc:class'] = self.objpath[0] self.env.temp_data['autodoc:class'] = self.objpath[0]
want_all = all_members or self.options.inherited_members or \ want_all = (all_members or
self.options.members is ALL self.options.inherited_members or
self.options.members is ALL)
# find out which members are documentable # find out which members are documentable
members_check_module, members = self.get_object_members(want_all) members_check_module, members = self.get_object_members(want_all)
@ -842,8 +843,7 @@ class Documenter:
classes.sort(key=lambda cls: cls.priority) classes.sort(key=lambda cls: cls.priority)
# give explicitly separated module name, so that members # give explicitly separated module name, so that members
# of inner classes can be documented # of inner classes can be documented
full_mname = self.modname + '::' + \ full_mname = self.modname + '::' + '.'.join(self.objpath + [mname])
'.'.join(self.objpath + [mname])
documenter = classes[-1](self.directive, full_mname, self.indent) documenter = classes[-1](self.directive, full_mname, self.indent)
memberdocumenters.append((documenter, isattr)) memberdocumenters.append((documenter, isattr))
@ -1968,8 +1968,8 @@ class DataDocumenter(GenericAliasMixin, NewTypeMixin, TypeVarMixin,
pass pass
def get_real_modname(self) -> str: def get_real_modname(self) -> str:
return self.get_attr(self.parent or self.object, '__module__', None) \ real_modname = self.get_attr(self.parent or self.object, '__module__', None)
or self.modname return real_modname or self.modname
def get_module_comment(self, attrname: str) -> Optional[List[str]]: def get_module_comment(self, attrname: str) -> Optional[List[str]]:
try: try:
@ -2034,8 +2034,7 @@ class MethodDocumenter(DocstringSignatureMixin, ClassLevelDocumenter): # type:
@classmethod @classmethod
def can_document_member(cls, member: Any, membername: str, isattr: bool, parent: Any def can_document_member(cls, member: Any, membername: str, isattr: bool, parent: Any
) -> bool: ) -> bool:
return inspect.isroutine(member) and \ return inspect.isroutine(member) and not isinstance(parent, ModuleDocumenter)
not isinstance(parent, ModuleDocumenter)
def import_object(self, raiseerror: bool = False) -> bool: def import_object(self, raiseerror: bool = False) -> bool:
ret = super().import_object(raiseerror) ret = super().import_object(raiseerror)
@ -2470,8 +2469,8 @@ class AttributeDocumenter(GenericAliasMixin, NewTypeMixin, SlotsMixin, # type:
return ret return ret
def get_real_modname(self) -> str: def get_real_modname(self) -> str:
return self.get_attr(self.parent or self.object, '__module__', None) \ real_modname = self.get_attr(self.parent or self.object, '__module__', None)
or self.modname return real_modname or self.modname
def should_suppress_value_header(self) -> bool: def should_suppress_value_header(self) -> bool:
if super().should_suppress_value_header(): if super().should_suppress_value_header():
@ -2572,8 +2571,8 @@ class PropertyDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): #
pass pass
def get_real_modname(self) -> str: def get_real_modname(self) -> str:
return self.get_attr(self.parent or self.object, '__module__', None) \ real_modname = self.get_attr(self.parent or self.object, '__module__', None)
or self.modname return real_modname or self.modname
def add_directive_header(self, sig: str) -> None: def add_directive_header(self, sig: str) -> None:
super().add_directive_header(sig) super().add_directive_header(sig)