Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2024-10-19 16:25:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1460678 - Improve mach doc performance, use sphinx's -J argument. r=ahal

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D41058

--HG--
extra : moz-landing-system : lando
This commit is contained in:
championshuttler 2019-08-13 13:18:24 +00:00
parent 9f31d5882a
commit 13bb66f32b
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
tools/docs/mach_commands.py
View File

@ -6,6 +6,7 @@ from __future__ import absolute_import, print_function, unicode_literals
import os
import sys
import multiprocessing
from functools import partial
from mozbuild.base import MachCommandBase
@ -49,8 +50,10 @@ class Documentation(MachCommandBase):
'default "localhost:5500".')
@CommandArgument('--upload', action='store_true',
help='Upload generated files to S3.')
@CommandArgument('-j', '--jobs', default=str(multiprocessing.cpu_count()), dest='jobs',
help='Distribute the build over N processes in parallel.')
def build_docs(self, path=None, fmt='html', outdir=None, auto_open=True,
serve=True, http=None, archive=False, upload=False):
serve=True, http=None, archive=False, upload=False, jobs=None):
from mozfile import which
@ -74,7 +77,7 @@ class Documentation(MachCommandBase):
return die('failed to generate documentation:\n'
'%s: could not find docs at this location' % path)
result = self._run_sphinx(docdir, savedir, fmt=fmt)
result = self._run_sphinx(docdir, savedir, fmt=fmt, jobs=jobs)
if result != 0:
return die('failed to generate documentation:\n'
'%s: sphinx return code %d' % (path, result))
@ -107,12 +110,12 @@ class Documentation(MachCommandBase):
sphinx_trees = self.manager.trees or {savedir: docdir}
for dest, src in sphinx_trees.items():
run_sphinx = partial(self._run_sphinx, src, savedir, fmt=fmt)
run_sphinx = partial(self._run_sphinx, src, savedir, fmt=fmt, jobs=jobs)
server.watch(src, run_sphinx)
server.serve(host=host, port=port, root=savedir,
open_url_delay=0.1 if auto_open else None)
def _run_sphinx(self, docdir, savedir, config=None, fmt='html'):
def _run_sphinx(self, docdir, savedir, config=None, fmt='html', jobs=None):
import sphinx
config = config or self.manager.conf_py_path
args = [
@ -122,6 +125,8 @@ class Documentation(MachCommandBase):
docdir,
savedir,
]
if jobs:
args.extend(['-j', jobs])
return sphinx.build_main(args)
@property