Skip to content

Commit

Permalink
[docs] clarify the proper 'make-mode' usage in the docs (#11992)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdillard committed Feb 27, 2024
1 parent d6f38ad commit fde43ed
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/man/sphinx-build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`,
Expand Down

0 comments on commit fde43ed

Please sign in to comment.