Merge pull request #3097 from agriyakhetarpal/parallel-build-docs

Enable multithreaded documentation builds

docs/Makefile

@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+SPHINXOPTS    = -j auto
 SPHINXBUILD   = sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
@@ -16,4 +16,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+    @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

noxfile.py

@@ -115,7 +115,13 @@ def run_tests(session):
 def build_docs(session):
     envbindir = session.bin
     session.install("-e", ".[docs]")
-    session.chdir("docs/")
-    session.run(
-        "sphinx-autobuild", "--open-browser", "-qT", ".", f"{envbindir}/../tmp/html"
-    )
+    with session.chdir("docs/"):
+        session.run(
+            "sphinx-autobuild",
+            "-j",
+            "auto",
+            "--open-browser",
+            "-qT",
+            ".",
+            f"{envbindir}/../tmp/html",
+        )

run-tests.py

@@ -68,6 +68,8 @@ def run_doc_tests():
     p = subprocess.Popen(
         [
             "sphinx-build",
+            "-j",
+            "auto",
             "-b",
             "doctest",
             "docs",

sphinx_extend_parent.py

@@ -25,3 +25,8 @@ def process_docstring(app, what, name, obj, options, lines):
 
 def setup(app):
     app.connect("autodoc-process-docstring", process_docstring)
+    return {
+        "version": "0.1.0",
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }