diff --git a/CHANGES.rst b/CHANGES.rst index f551c76ec48..e2a7f999f37 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -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 -------------- diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index f90389cc4b2..882ab36fdf0 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -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 diff --git a/doc/man/sphinx-quickstart.rst b/doc/man/sphinx-quickstart.rst index d050a29c61e..cc6673d3afd 100644 --- a/doc/man/sphinx-quickstart.rst +++ b/doc/man/sphinx-quickstart.rst @@ -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. diff --git a/sphinx/cmd/quickstart.py b/sphinx/cmd/quickstart.py index 89aec45ce78..fac494ac1ec 100644 --- a/sphinx/cmd/quickstart.py +++ b/sphinx/cmd/quickstart.py @@ -396,10 +396,13 @@ def write_file(fpath: str, content: str, newline: str | None = None) -> None: 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 write_file(fpath: str, content: str, newline: str | None = None) -> None: 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: