support sphinx-build -j<N> (parallel build)

pallets · Apr 29, 2024 · 0e9c08c · 0e9c08c
1 parent 563cce1
commit 0e9c08c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -3,6 +3,7 @@ Version 2.1.3
 
 Unreleased
 
+-   Allow Sphinx's parallel build feature. :issue:`88`
 
 Version 2.1.2
 -------------

diff --git a/src/pallets_sphinx_themes/themes/click/domain.py b/src/pallets_sphinx_themes/themes/click/domain.py
@@ -255,6 +255,11 @@ class ClickDomain(Domain):
     label = "Click"
     directives = {"example": DeclareExampleDirective, "run": RunExampleDirective}
 
+    def merge_domaindata(self, docnames, otherdata):
+        # Needed to support parallel build.
+        # Not using self.data -- nothing to merge.
+        pass
+
 
 def delete_example_runner_state(app, doctree):
     """Close and remove the :class:`ExampleRunner` instance once the

diff --git a/src/pallets_sphinx_themes/themes/jinja/domain.py b/src/pallets_sphinx_themes/themes/jinja/domain.py
@@ -258,6 +258,11 @@ class JinjaDomain(Domain):
         "nodes": NodesDirective,
     }
 
+    def merge_domaindata(self, docnames, otherdata):
+        # Needed to support parallel build.
+        # Not using self.data -- nothing to merge.
+        pass
+
 
 def setup(app):
     app.add_domain(JinjaDomain)