mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
#3751 document -M command line option
This commit is contained in:
@@ -89,6 +89,26 @@ Options
|
||||
See :ref:`builders` for a list of all builders shipped with Sphinx.
|
||||
Extensions can add their own builders.
|
||||
|
||||
.. _make_mode:
|
||||
|
||||
.. option:: -M buildername
|
||||
|
||||
Alternative to :option:`-b`. Uses the Sphinx :program:`make_mode` module,
|
||||
which provides the same build functionality as a default :ref:`Makefile or
|
||||
Make.bat <makefile_options>`. In addition to all Sphinx
|
||||
:ref:`builders <builders>`, the following build pipelines are available:
|
||||
|
||||
**latexpdf**
|
||||
Build LaTeX files and run them through :program:`pdflatex`.
|
||||
|
||||
**latexpdfja**
|
||||
Build LaTeX files and run them through :program:`platex/dvipdfmx`.
|
||||
|
||||
**info**
|
||||
Build Texinfo files and run them through :program:`makeinfo`.
|
||||
|
||||
.. versionadded:: 1.2.1
|
||||
|
||||
.. option:: -a
|
||||
|
||||
If given, always write all output files. The default is to only write output
|
||||
@@ -235,6 +255,8 @@ The :program:`sphinx-build` refers following environment variables:
|
||||
A path to make command. A command name is also allowed.
|
||||
:program:`sphinx-build` uses it to invoke sub-build process on make-mode.
|
||||
|
||||
.. _makefile_options:
|
||||
|
||||
.. rubric:: Makefile Options
|
||||
|
||||
The :file:`Makefile` and :file:`make.bat` files created by
|
||||
|
||||
@@ -120,7 +120,8 @@ Options
|
||||
|
||||
.. option:: --use-make-mode, --no-use-make-mode
|
||||
|
||||
Makefile/make.bat uses (or not use) make-mode. Default is use.
|
||||
:file:`Makefile/make.bat` uses (or doesn't use) :ref:`make-mode <make_mode>`.
|
||||
Default is `use`, which generates a more concise :file:`Makefile/make.bat`.
|
||||
|
||||
.. versionchanged:: 1.5
|
||||
make-mode is default.
|
||||
|
||||
Reference in New Issue
Block a user