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

Make `--jobs a synonym for -j` (#11210)

Browse Source 
Make --jobs a synonym for -j
This commit is contained in:
Hugo van Kemenade 2023-03-05 16:37:35 +02:00 committed by GitHub
parent c5641702b5
commit 219d71315c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/man/sphinx-build.rst
View File

@ -138,7 +138,7 @@ 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 .. option:: -j N, --jobs N
Distribute the build over *N* processes in parallel, to make building on Distribute the build over *N* processes in parallel, to make building on
multiprocessor machines more effective. Note that not all parts and not all multiprocessor machines more effective. Note that not all parts and not all
@ -151,6 +151,9 @@ Options
.. versionchanged:: 1.7 .. versionchanged:: 1.7
Support ``auto`` argument. Support ``auto`` argument.
.. versionchanged:: 6.2
Add ``--jobs`` long option.
.. 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

3
sphinx/cmd/build.py
View File

@ -142,7 +142,8 @@ files can be built by specifying individual filenames.
group.add_argument('-d', metavar='PATH', dest='doctreedir', group.add_argument('-d', metavar='PATH', dest='doctreedir',
help=__('path for the cached environment and doctree ' help=__('path for the cached environment and doctree '
'files (default: OUTPUTDIR/.doctrees)')) 'files (default: OUTPUTDIR/.doctrees)'))
group.add_argument('-j', metavar='N', default=1, type=jobs_argument, dest='jobs', group.add_argument('-j', '--jobs', metavar='N', default=1, type=jobs_argument,
dest='jobs',
help=__('build in parallel with N processes where ' help=__('build in parallel with N processes where '
'possible (special value "auto" will set N to cpu-count)')) 'possible (special value "auto" will set N to cpu-count)'))
group = parser.add_argument_group('build configuration options') group = parser.add_argument_group('build configuration options')