Merge pull request #6509 from tk0miya/refactor_autosummary4

Suppress deprecation warning for autosummary
This commit is contained in:
Takeshi KOMIYA 2019-06-19 13:54:47 +09:00 committed by GitHub
commit 673922b055
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -208,23 +208,25 @@ def generate_autosummary_docs(sources, output_dir=None, suffix='.rst',
if info: if info:
warnings.warn('info argument for generate_autosummary_docs() is deprecated.', warnings.warn('info argument for generate_autosummary_docs() is deprecated.',
RemovedInSphinx40Warning) RemovedInSphinx40Warning)
_info = info
else: else:
info = logger.info _info = logger.info
if warn: if warn:
warnings.warn('warn argument for generate_autosummary_docs() is deprecated.', warnings.warn('warn argument for generate_autosummary_docs() is deprecated.',
RemovedInSphinx40Warning) RemovedInSphinx40Warning)
_warn = warn
else: else:
warn = logger.warning _warn = logger.warning
showed_sources = list(sorted(sources)) showed_sources = list(sorted(sources))
if len(showed_sources) > 20: if len(showed_sources) > 20:
showed_sources = showed_sources[:10] + ['...'] + showed_sources[-10:] showed_sources = showed_sources[:10] + ['...'] + showed_sources[-10:]
info(__('[autosummary] generating autosummary for: %s') % _info(__('[autosummary] generating autosummary for: %s') %
', '.join(showed_sources)) ', '.join(showed_sources))
if output_dir: if output_dir:
info(__('[autosummary] writing to %s') % output_dir) _info(__('[autosummary] writing to %s') % output_dir)
if base_path is not None: if base_path is not None:
sources = [os.path.join(base_path, filename) for filename in sources] sources = [os.path.join(base_path, filename) for filename in sources]
@ -250,7 +252,7 @@ def generate_autosummary_docs(sources, output_dir=None, suffix='.rst',
try: try:
name, obj, parent, mod_name = import_by_name(name) name, obj, parent, mod_name = import_by_name(name)
except ImportError as e: except ImportError as e:
warn('[autosummary] failed to import %r: %s' % (name, e)) _warn('[autosummary] failed to import %r: %s' % (name, e))
continue continue
fn = os.path.join(path, name + suffix) fn = os.path.join(path, name + suffix)