mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Deprecate old-style Makefiles in sphinx-quickstart (#11693)
This commit is contained in:
parent
5fe0bd41eb
commit
9d1dcae373
@ -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
|
||||
--------------
|
||||
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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:
|
||||
|
Loading…
Reference in New Issue
Block a user