mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
refactor: Deprecate unused parameters
This commit is contained in:
parent
931bfcca88
commit
0374d217d4
2
CHANGES
2
CHANGES
@ -18,6 +18,8 @@ Deprecated
|
|||||||
AutosummaryRenderer``
|
AutosummaryRenderer``
|
||||||
* The ``module`` argument of ``sphinx.ext.autosummary.generate.
|
* The ``module`` argument of ``sphinx.ext.autosummary.generate.
|
||||||
find_autosummary_in_docstring()``
|
find_autosummary_in_docstring()``
|
||||||
|
* The ``builder`` argument of ``sphinx.ext.autosummary.generate.
|
||||||
|
generate_autosummary_docs()``
|
||||||
* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
|
* The ``template_dir`` argument of ``sphinx.ext.autosummary.generate.
|
||||||
generate_autosummary_docs()``
|
generate_autosummary_docs()``
|
||||||
|
|
||||||
|
@ -45,6 +45,12 @@ The following is a list of deprecated interfaces.
|
|||||||
- 5.0
|
- 5.0
|
||||||
- N/A
|
- N/A
|
||||||
|
|
||||||
|
* - The ``builder`` argument of
|
||||||
|
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
|
||||||
|
- 3.1
|
||||||
|
- 5.0
|
||||||
|
- N/A
|
||||||
|
|
||||||
* - The ``template_dir`` argument of
|
* - The ``template_dir`` argument of
|
||||||
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
|
``sphinx.ext.autosummary.generate.generate_autosummary_docs()``
|
||||||
- 3.1
|
- 3.1
|
||||||
|
@ -279,6 +279,10 @@ def generate_autosummary_docs(sources: List[str], output_dir: str = None,
|
|||||||
else:
|
else:
|
||||||
_warn = logger.warning
|
_warn = logger.warning
|
||||||
|
|
||||||
|
if builder:
|
||||||
|
warnings.warn('builder argument for generate_autosummary_docs() is deprecated.',
|
||||||
|
RemovedInSphinx50Warning)
|
||||||
|
|
||||||
if template_dir:
|
if template_dir:
|
||||||
warnings.warn('template_dir argument for generate_autosummary_docs() is deprecated.',
|
warnings.warn('template_dir argument for generate_autosummary_docs() is deprecated.',
|
||||||
RemovedInSphinx50Warning)
|
RemovedInSphinx50Warning)
|
||||||
@ -342,7 +346,7 @@ def generate_autosummary_docs(sources: List[str], output_dir: str = None,
|
|||||||
if new_files:
|
if new_files:
|
||||||
generate_autosummary_docs(new_files, output_dir=output_dir,
|
generate_autosummary_docs(new_files, output_dir=output_dir,
|
||||||
suffix=suffix, warn=warn, info=info,
|
suffix=suffix, warn=warn, info=info,
|
||||||
base_path=base_path, builder=builder,
|
base_path=base_path,
|
||||||
imported_members=imported_members, app=app,
|
imported_members=imported_members, app=app,
|
||||||
overwrite=overwrite)
|
overwrite=overwrite)
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user