DOC: Enable parallel builds

QuLogic · QuLogic · commit 82349cf1dbb2 · 2024-07-26T01:47:33.000-04:00
The latest sphinx-gallery 0.17.0 adds support for parallel building of
examples, and the issue in pydata-sphinx-theme was fixed in 0.15.4, so
we can try enabling it again.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -147,7 +147,7 @@ commands:
               export RELEASE_TAG='-t release'
             fi
             mkdir -p logs
-            make html O="-T $RELEASE_TAG -j1 -w /tmp/sphinxerrorswarnings.log"
+            make html O="-T $RELEASE_TAG -j4 -w /tmp/sphinxerrorswarnings.log"
             rm -r build/html/_sources
           working_directory: doc
       - save_cache:
diff --git a/doc/conf.py b/doc/conf.py
@@ -286,6 +286,11 @@ def tutorials_download_error(record):
     'copyfile_regex': r'.*\.rst',
 }
 
+if parse_version(sphinx_gallery.__version__) >= parse_version('0.17.0'):
+    sphinx_gallery_conf['parallel'] = True
+    # Any warnings from joblib turned into errors may cause a deadlock.
+    warnings.filterwarnings('default', category=UserWarning, module='joblib')
+
 if 'plot_gallery=0' in sys.argv:
     # Gallery images are not created.  Suppress warnings triggered where other
     # parts of the documentation link to these images.
diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -20,5 +20,5 @@ pyyaml
 sphinxcontrib-svg2pdfconverter>=1.1.0
 sphinx-copybutton
 sphinx-design
-sphinx-gallery>=0.12.0
+sphinx-gallery[parallel]>=0.12.0
 sphinx-tags>=0.4.0
