Deprecate old-style Makefiles in sphinx-quickstart (#11693)

This commit is contained in:
Adam Turner 2023-09-21 10:25:00 +01:00 committed by GitHub
parent 5fe0bd41eb
commit 9d1dcae373
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 24 additions and 1 deletions

View File

@ -10,6 +10,10 @@ Incompatible changes
Deprecated
----------
* #11693: Support for old-style :file:`Makefile` and :file:`make.bat` output
in :program:`sphinx-quickstart`, and the associated options :option:`!-M`,
:option:`!-m`, :option:`!--no-use-make-mode`, and :option:`!--use-make-mode`.
Features added
--------------

View File

@ -22,6 +22,15 @@ The following is a list of deprecated interfaces.
- Removed
- Alternatives
* - Old-style Makefiles in ``sphinx-quickstart``
and the :option:`!-M`, :option:`!-m`, :option:`!--no-use-make-mode`,
and :option:`!--use-make-mode` options
- 7.3
- 9.0
- Vendoring the `old style Makefile templates`__
__ https://github.com/sphinx-doc/sphinx/blob/v7.0.0/sphinx/templates/quickstart/Makefile_t
* - ``sphinx.ext.autodoc.preserve_defaults.get_function_def()``
- 7.2
- 9.0

View File

@ -130,6 +130,9 @@ Options
.. versionchanged:: 1.5
make-mode is default.
.. versionchanged:: 7.3
Support for disabling the make-mode will be removed in Sphinx 8.
.. option:: --makefile, --no-makefile
Create (or not create) makefile.

View File

@ -396,10 +396,13 @@ def generate(
else:
write_file(masterfile, template.render('quickstart/root_doc.rst_t', d))
if d.get('make_mode') is True:
if d.get('make_mode'):
makefile_template = 'quickstart/Makefile.new_t'
batchfile_template = 'quickstart/make.bat.new_t'
else:
# xref RemovedInSphinx80Warning
msg = "Support for '--no-use-make-mode' will be removed in Sphinx 8."
print(colorize('red', msg))
makefile_template = 'quickstart/Makefile_t'
batchfile_template = 'quickstart/make.bat_t'
@ -432,6 +435,10 @@ def generate(
print(__('where "builder" is one of the supported builders, '
'e.g. html, latex or linkcheck.'))
print()
if not d.get('make_mode'):
# xref RemovedInSphinx80Warning
msg = "Support for '--no-use-make-mode' will be removed in Sphinx 8."
print(colorize('red', msg))
def valid_dir(d: dict) -> bool: