Georg Brandl  committed a00063e

docs: document -j option and add changelog

  • Participants
  • Parent commits 28de52f
  • Branches default

Comments (0)

Files changed (2)

 Release 1.2 (in development)
+* PR#108: Add experimental support for parallel building with a new
+  :option:`-j` option.
 * #1070: Avoid un-pickling issues when running Python 3 and the saved
   environment was created under Python 2.

File doc/invocation.rst

    the build directory; with this option you can select a different cache
    directory (the doctrees can be shared between all builders).
+.. option:: -j N
+   Distribute the build over *N* processes in parallel, to make building on
+   multiprocessor machines more effective.  Note that not all parts and not all
+   builders of Sphinx can be parallelized.
+   .. versionadded:: 1.2
+      This option should be considered *experimental*.
 .. option:: -c path
    Don't look for the :file:`` in the source directory, but use the given