mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
autosummary: deprecate info and warn arguments for generate_autosummary_docs()
This commit is contained in:
parent
d9d0e49ea9
commit
649ebea438
5
CHANGES
5
CHANGES
@ -10,6 +10,11 @@ Incompatible changes
|
||||
Deprecated
|
||||
----------
|
||||
|
||||
* The ``info`` and ``warn`` arguments of
|
||||
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
|
||||
* ``sphinx.ext.autosummary.generate._simple_info()``
|
||||
* ``sphinx.ext.autosummary.generate._simple_warn()``
|
||||
|
||||
Features added
|
||||
--------------
|
||||
|
||||
|
@ -26,6 +26,22 @@ The following is a list of deprecated interfaces.
|
||||
- (will be) Removed
|
||||
- Alternatives
|
||||
|
||||
* - The ``info`` and ``warn`` arguments of
|
||||
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
|
||||
- 2.2
|
||||
- 4.0
|
||||
- ``logging.info()`` and ``logging.warning()``
|
||||
|
||||
* - ``sphinx.ext.autosummary.generate._simple_info()``
|
||||
- 2.2
|
||||
- 4.0
|
||||
- ``logging.info()``
|
||||
|
||||
* - ``sphinx.ext.autosummary.generate._simple_warn()``
|
||||
- 2.2
|
||||
- 4.0
|
||||
- ``logging.warning()``
|
||||
|
||||
* - ``sphinx.builders.latex.LaTeXBuilder.apply_transforms()``
|
||||
- 2.1
|
||||
- 4.0
|
||||
|
@ -754,7 +754,6 @@ def process_generate_options(app):
|
||||
imported_members = app.config.autosummary_imported_members
|
||||
with mock(app.config.autosummary_mock_imports):
|
||||
generate_autosummary_docs(genfiles, builder=app.builder,
|
||||
warn=logger.warning, info=logger.info,
|
||||
suffix=suffix, base_path=app.srcdir,
|
||||
app=app, imported_members=imported_members)
|
||||
|
||||
|
@ -23,6 +23,7 @@ import os
|
||||
import pydoc
|
||||
import re
|
||||
import sys
|
||||
import warnings
|
||||
|
||||
from jinja2 import BaseLoader, FileSystemLoader, TemplateNotFound
|
||||
from jinja2.sandbox import SandboxedEnvironment
|
||||
@ -30,10 +31,12 @@ from jinja2.sandbox import SandboxedEnvironment
|
||||
import sphinx.locale
|
||||
from sphinx import __display_version__
|
||||
from sphinx import package_dir
|
||||
from sphinx.deprecation import RemovedInSphinx40Warning
|
||||
from sphinx.ext.autosummary import import_by_name, get_documenter
|
||||
from sphinx.jinja2glue import BuiltinTemplateLoader
|
||||
from sphinx.locale import __
|
||||
from sphinx.registry import SphinxComponentRegistry
|
||||
from sphinx.util import logging
|
||||
from sphinx.util import rst
|
||||
from sphinx.util.inspect import safe_getattr
|
||||
from sphinx.util.osutil import ensuredir
|
||||
@ -45,12 +48,17 @@ if False:
|
||||
from sphinx.ext.autodoc import Documenter # NOQA
|
||||
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class DummyApplication:
|
||||
"""Dummy Application class for sphinx-autogen command."""
|
||||
|
||||
def __init__(self):
|
||||
# type: () -> None
|
||||
self.registry = SphinxComponentRegistry()
|
||||
self.messagelog = [] # type: List[str]
|
||||
self.verbosity = 0
|
||||
|
||||
|
||||
def setup_documenters(app):
|
||||
@ -127,10 +135,20 @@ class AutosummaryRenderer:
|
||||
# -- Generating output ---------------------------------------------------------
|
||||
|
||||
def generate_autosummary_docs(sources, output_dir=None, suffix='.rst',
|
||||
warn=_simple_warn, info=_simple_info,
|
||||
base_path=None, builder=None, template_dir=None,
|
||||
imported_members=False, app=None):
|
||||
warn=None, info=None, base_path=None, builder=None,
|
||||
template_dir=None, imported_members=False, app=None):
|
||||
# type: (List[str], str, str, Callable, Callable, str, Builder, str, bool, Any) -> None
|
||||
if info:
|
||||
warnings.warn('info argument for generate_autosummary_docs() is deprecated.',
|
||||
RemovedInSphinx40Warning)
|
||||
else:
|
||||
info = logger.info
|
||||
|
||||
if warn:
|
||||
warnings.warn('warn argument for generate_autosummary_docs() is deprecated.',
|
||||
RemovedInSphinx40Warning)
|
||||
else:
|
||||
warn = logger.warning
|
||||
|
||||
showed_sources = list(sorted(sources))
|
||||
if len(showed_sources) > 20:
|
||||
@ -420,6 +438,7 @@ def main(argv=sys.argv[1:]):
|
||||
sphinx.locale.init_console(os.path.join(package_dir, 'locale'), 'sphinx')
|
||||
|
||||
app = DummyApplication()
|
||||
logging.setup(app, sys.stdout, sys.stderr) # type: ignore
|
||||
setup_documenters(app)
|
||||
args = get_parser().parse_args(argv)
|
||||
generate_autosummary_docs(args.source_file, args.output_dir,
|
||||
|
Loading…
Reference in New Issue
Block a user