IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: document -j option and add changelog

Browse Source
This commit is contained in:
Georg Brandl 2013-01-14 08:38:46 +01:00
parent 3889a1158f
commit c59cb9d6f6
2 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES
View File

@ -1,6 +1,9 @@
Release 1.2 (in development) 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 * #1070: Avoid un-pickling issues when running Python 3 and the saved
environment was created under Python 2. environment was created under Python 2.

9
doc/invocation.rst
View File

@ -96,6 +96,15 @@ The :program:`sphinx-build` script has several options:
the build directory; with this option you can select a different cache the build directory; with this option you can select a different cache
directory (the doctrees can be shared between all builders). 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 .. option:: -c path
Don't look for the :file:`conf.py` in the source directory, but use the given Don't look for the :file:`conf.py` in the source directory, but use the given