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 autodoc: crashed when invalid options given

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-03-01 02:18:35 +09:00
parent 3efadc63cc
commit adc8c80190
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@ -18,6 +18,7 @@ Bugs fixed
* #4669: sphinx.build_main and sphinx.make_main throw NameError * #4669: sphinx.build_main and sphinx.make_main throw NameError
* #4685: autosummary emits meaningless warnings * #4685: autosummary emits meaningless warnings
* autodoc: crashed when invalid options given
Testing Testing
-------- --------

4
sphinx/ext/autodoc/directive.py
View File

@ -58,7 +58,7 @@ class DocumenterBridge(object):
def warn(self, msg): def warn(self, msg):
# type: (unicode) -> None # type: (unicode) -> None
logger.warning(msg, line=self.lineno) logger.warning(msg, location=(self.env.docname, self.lineno))
def process_documenter_options(documenter, config, options): def process_documenter_options(documenter, config, options):
@ -125,7 +125,7 @@ class AutodocDirective(Directive):
except (KeyError, ValueError, TypeError) as exc: except (KeyError, ValueError, TypeError) as exc:
# an option is either unknown or has a wrong type # an option is either unknown or has a wrong type
logger.error('An option to %s is either unknown or has an invalid value: %s' % logger.error('An option to %s is either unknown or has an invalid value: %s' %
(self.name, exc), line=lineno) (self.name, exc), location=(source, lineno))
return [] return []
# generate the output # generate the output