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

Fix #8143: AttributeError if autodoc_default_options contains False

Browse Source 
autodoc crahses when autodoc_default_options contains False value
unexpectedly.  After this change, it also accepts False.
This commit is contained in:
Takeshi KOMIYA 2020-08-22 00:44:07 +09:00
parent f861b4cd1a
commit e0b2162a77
2 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -17,6 +17,8 @@ Bugs fixed
---------- ----------
* #8085: i18n: Add support for having single text domain * #8085: i18n: Add support for having single text domain
* #8143: autodoc: AttributeError is raised when False value is passed to
autodoc_default_options
* #8093: The highlight warning has wrong location in some builders (LaTeX, * #8093: The highlight warning has wrong location in some builders (LaTeX,
singlehtml and so on) singlehtml and so on)

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

@ -94,7 +94,10 @@ def members_option(arg: Any) -> Union[object, List[str]]:
"""Used to convert the :members: option to auto directives.""" """Used to convert the :members: option to auto directives."""
if arg is None or arg is True: if arg is None or arg is True:
return ALL return ALL
return [x.strip() for x in arg.split(',') if x.strip()] elif arg is False:
return None
else:
return [x.strip() for x in arg.split(',') if x.strip()]
def members_set_option(arg: Any) -> Union[object, Set[str]]: def members_set_option(arg: Any) -> Union[object, Set[str]]:
@ -172,7 +175,7 @@ def merge_members_option(options: Dict) -> None:
members = options.setdefault('members', []) members = options.setdefault('members', [])
for key in {'private-members', 'special-members'}: for key in {'private-members', 'special-members'}:
if key in options and options[key] is not ALL: if key in options and options[key] not in (ALL, None):
for member in options[key]: for member in options[key]:
if member not in members: if member not in members:
members.append(member) members.append(member)