Skip to content

Commit

Permalink
Deprecate old-style Makefiles in sphinx-quickstart (#11693)
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Sep 21, 2023
1 parent 5fe0bd4 commit 9d1dcae
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------

Expand Down
9 changes: 9 additions & 0 deletions doc/extdev/deprecated.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions doc/man/sphinx-quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 8 additions & 1 deletion sphinx/cmd/quickstart.py
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 9d1dcae

Please sign in to comment.