Merge pull request #6993 from tacaswell/doc_parallel_build

jenshnielsen · web-flow · commit 6ca5ad8617bd · 2016-08-29T07:37:55.000+01:00
Doc parallel build
diff --git a/.travis.yml b/.travis.yml
@@ -142,7 +142,7 @@ script:
       gdb -return-child-result -batch -ex r -ex bt --args python tests.py -s --processes=$NPROC --process-timeout=300 $TEST_ARGS
     else
       cd doc
-      python make.py html
+      python make.py html -n 2
       # We don't build the LaTeX docs here, so linkchecker will complain
       touch build/html/Matplotlib.pdf
       linkchecker build/html/index.html
diff --git a/doc/make.py b/doc/make.py
@@ -52,7 +52,8 @@ def html(buildername='html'):
         options = ''
     if warnings_as_errors:
         options = options + ' -W'
-    if os.system('sphinx-build %s -b %s -d build/doctrees . build/%s' % (options, buildername, buildername)):
+    if os.system('sphinx-build -j %d %s -b %s -d build/doctrees . build/%s' % (
+            n_proc, options, buildername, buildername)):
         raise SystemExit("Building HTML failed.")
 
     # Clean out PDF files from the _images directory
@@ -67,7 +68,7 @@ def htmlhelp():
     with open('build/htmlhelp/index.html', 'r+') as fh:
         content = fh.read()
         fh.seek(0)
-        content = re.sub(r'<script>.*?</script>', '', content, 
+        content = re.sub(r'<script>.*?</script>', '', content,
                          flags=re.MULTILINE| re.DOTALL)
         fh.write(content)
         fh.truncate()
@@ -146,6 +147,7 @@ def all():
 
 small_docs = False
 warnings_as_errors = True
+n_proc = 1
 
 # Change directory to the one containing this file
 current_dir = os.getcwd()
@@ -194,11 +196,16 @@ def all():
 parser.add_argument("--allowsphinxwarnings",
                     help="Don't turn Sphinx warnings into errors",
                     action="store_true")
+parser.add_argument("-n",
+                    help="Number of parallel workers to use")
+
 args = parser.parse_args()
 if args.small:
     small_docs = True
 if args.allowsphinxwarnings:
     warnings_as_errors = False
+if args.n is not None:
+    n_proc = int(args.n)
 
 if args.cmd:
     for command in args.cmd:
diff --git a/doc/sphinxext/gen_gallery.py b/doc/sphinxext/gen_gallery.py
@@ -168,3 +168,6 @@ def setup(app):
         app.add_config_value('mpl_example_sections', [], True)
     except sphinx.errors.ExtensionError:
         pass # mpl_example_sections already defined
+
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
+    return metadata
diff --git a/doc/sphinxext/gen_rst.py b/doc/sphinxext/gen_rst.py
@@ -169,3 +169,6 @@ def setup(app):
         app.add_config_value('mpl_example_sections', [], True)
     except sphinx.errors.ExtensionError:
         pass # mpl_example_sections already defined
+
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
+    return metadata
diff --git a/doc/sphinxext/github.py b/doc/sphinxext/github.py
@@ -143,7 +143,7 @@ def ghcommit_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
 
 def setup(app):
     """Install the plugin.
-    
+
     :param app: Sphinx application context.
     """
     app.info('Initializing GitHub plugin')
@@ -152,4 +152,6 @@ def setup(app):
     app.add_role('ghuser', ghuser_role)
     app.add_role('ghcommit', ghcommit_role)
     app.add_config_value('github_project_url', None, 'env')
-    return
+
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
+    return metadata
diff --git a/doc/sphinxext/math_symbol_table.py b/doc/sphinxext/math_symbol_table.py
@@ -138,6 +138,9 @@ def setup(app):
         'math_symbol_table', math_symbol_table_directive,
         False, (0, 1, 0))
 
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
+    return metadata
+
 if __name__ == "__main__":
     # Do some verification of the tables
     from matplotlib import _mathtext_data
diff --git a/lib/matplotlib/sphinxext/mathmpl.py b/lib/matplotlib/sphinxext/mathmpl.py
@@ -118,3 +118,6 @@ def depart_latex_math_latex(self, node):
     app.add_role('math', math_role)
     app.add_directive('math', math_directive,
                       True, (0, 0, 0), **options_spec)
+
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
+    return metadata
diff --git a/lib/matplotlib/sphinxext/only_directives.py b/lib/matplotlib/sphinxext/only_directives.py
@@ -64,9 +64,10 @@ def visit_ignore(self, node):
     def depart_ignore(self, node):
         node.children = []
 
-    app.add_node(html_only,
-                 html=(visit_perform, depart_perform),
-                 latex=(visit_ignore, depart_ignore))
-    app.add_node(latex_only,
-                 latex=(visit_perform, depart_perform),
-                 html=(visit_ignore, depart_ignore))
+    app.add_node(html_only, html=(visit_perform, depart_perform))
+    app.add_node(html_only, latex=(visit_ignore, depart_ignore))
+    app.add_node(latex_only, latex=(visit_perform, depart_perform))
+    app.add_node(latex_only, html=(visit_ignore, depart_ignore))
+
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
+    return metadata
