Skip to content

Commit

Permalink
sphinx-doc#3751 document -M command line option
Browse files Browse the repository at this point in the history
  • Loading branch information
TimKam committed Jul 16, 2017
1 parent d59fdda commit 68fe4b2
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
22 changes: 22 additions & 0 deletions doc/man/sphinx-build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion doc/man/sphinx-quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 68fe4b2

Please sign in to comment.