Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate old-style Makefiles in sphinx-quickstart #11693

Merged
merged 3 commits into from
Sep 21, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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