Merge pull request #173 from rscohn2/master

declare the extension as parallel read safe

Author: adamtheturtle

.github/workflows/ci.yml

@@ -45,6 +45,10 @@ jobs:
         run: |
           make build-sample
 
+      - name: "Build sample parallel"
+        run: |
+          make build-sample-parallel
+
       - name: "Run tests"
         run: |
           pytest -s -vvv --cov-fail-under 100 --cov=src/ --cov=tests tests/ --cov-report=xml

Makefile

@@ -29,6 +29,11 @@ build-sample:
 	rm -rf sample/build
 	sphinx-build -W -b html sample/source sample/build
 
+.PHONY: build-sample-parallel
+build-sample-parallel:
+	rm -rf sample/build
+	sphinx-build -j 2 -W -b html sample/source sample/build
+
 .PHONY: open-sample
 open-sample:
 	python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("sample/build/index.html"))'

sample/source/five.rst

@@ -0,0 +1,4 @@
+=======
+ Five
+=======
+

sample/source/four.rst

@@ -0,0 +1,4 @@
+=======
+ Four
+=======
+

sample/source/index.rst

@@ -71,3 +71,18 @@ Inline ``:code:``
 :code:`echo "The author is |author|"`
 
 :substitution-code:`echo "The author is |author|"`
+
+..
+
+  This is a test of parallel document builds. You need at least 5
+  documents. See:
+  https://github.com/adamtheturtle/sphinx-substitution-extensions/pull/173
+
+.. toctree::
+   :hidden:
+
+   one
+   two
+   three
+   four
+   five

sample/source/one.rst

@@ -0,0 +1,4 @@
+=====
+ One
+=====
+

sample/source/three.rst

@@ -0,0 +1,4 @@
+=======
+ Three
+=======
+

sample/source/two.rst

@@ -0,0 +1,4 @@
+=====
+ Two
+=====
+

src/sphinx_substitution_extensions/__init__.py

@@ -146,11 +146,12 @@ def substitution_code_role(  # pylint: disable=dangerous-default-value
 }
 
 
-def setup(app: Sphinx) -> None:
+def setup(app: Sphinx) -> dict:
     """
     Add the custom directives to Sphinx.
     """
     app.add_config_value('substitutions', [], 'html')
     directives.register_directive('prompt', SubstitutionPrompt)
     directives.register_directive('code-block', SubstitutionCodeBlock)
     app.add_role('substitution-code', substitution_code_role)
+    return {'parallel_read_safe': True}