diff --git a/CHANGES b/CHANGES index d3c4b8016..bebfc5500 100644 --- a/CHANGES +++ b/CHANGES @@ -18,6 +18,8 @@ Deprecated AutosummaryRenderer`` * The ``module`` argument of ``sphinx.ext.autosummary.generate. find_autosummary_in_docstring()`` +* The ``builder`` argument of ``sphinx.ext.autosummary.generate. + generate_autosummary_docs()`` * The ``template_dir`` argument of ``sphinx.ext.autosummary.generate. generate_autosummary_docs()`` diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index 6e9520046..d39b00b37 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -45,6 +45,12 @@ The following is a list of deprecated interfaces. - 5.0 - N/A + * - The ``builder`` argument of + ``sphinx.ext.autosummary.generate.generate_autosummary_docs()`` + - 3.1 + - 5.0 + - N/A + * - The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.generate_autosummary_docs()`` - 3.1 diff --git a/sphinx/ext/autosummary/generate.py b/sphinx/ext/autosummary/generate.py index 0c932cec4..df7ad4b1d 100644 --- a/sphinx/ext/autosummary/generate.py +++ b/sphinx/ext/autosummary/generate.py @@ -279,6 +279,10 @@ def generate_autosummary_docs(sources: List[str], output_dir: str = None, else: _warn = logger.warning + if builder: + warnings.warn('builder argument for generate_autosummary_docs() is deprecated.', + RemovedInSphinx50Warning) + if template_dir: warnings.warn('template_dir argument for generate_autosummary_docs() is deprecated.', RemovedInSphinx50Warning) @@ -342,7 +346,7 @@ def generate_autosummary_docs(sources: List[str], output_dir: str = None, if new_files: generate_autosummary_docs(new_files, output_dir=output_dir, suffix=suffix, warn=warn, info=info, - base_path=base_path, builder=builder, + base_path=base_path, imported_members=imported_members, app=app, overwrite=overwrite)