[docs] clarify the proper 'make-mode' usage in the docs (#11992)

This commit is contained in:
Jared Dillard 2024-02-27 00:03:15 -08:00 committed by GitHub
parent d6f38ade54
commit fde43ed8b4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -39,7 +39,11 @@ Options
Extensions can add their own builders.
.. important::
Sphinx only recognizes the ``-M`` option if it is used first.
Sphinx only recognizes the ``-M`` option if it is used first, along with
the source and output directories, before any other options are passed.
For example::
sphinx-build -M html ./source ./build -W --keep-going
The *make-mode* provides the same build functionality as
a default :ref:`Makefile or Make.bat <makefile_options>`,