Handling lack of forking on Windows.

On Windows multiprocess.Process() performs a "spawn" instead of "fork"
since fork doesn't exist on Windows. The problem with spawn is the child
process starts from scratch and the Click context is empty (vs populated
on *nix). Moving Config.from_context() call pre-fork so it's passed on
via pickle instead.

Fixing more tests with os.path.join() instead of hard coded Unix path
separator.

Author: Robpol86

sphinxcontrib/versioning/sphinx_.py

@@ -159,16 +159,15 @@ def __init__(self, dirname, filename, overrides, tags):
         self.extensions.append('sphinxcontrib.versioning.sphinx_')
 
 
-def _build(argv, versions, current_name, is_root):
+def _build(argv, config, versions, current_name, is_root):
     """Build Sphinx docs via multiprocessing for isolation.
 
     :param tuple argv: Arguments to pass to Sphinx.
+    :param sphinxcontrib.versioning.lib.Config config: Runtime configuration.
     :param sphinxcontrib.versioning.versions.Versions versions: Versions class instance.
     :param str current_name: The ref name of the current version being built.
     :param bool is_root: Is this build in the web root?
     """
-    config = Config.from_context()
-
     # Patch.
     application.Config = ConfigInject
     if config.show_banner:
@@ -195,18 +194,19 @@ def _build(argv, versions, current_name, is_root):
         raise SphinxError
 
 
-def _read_config(argv, current_name, queue):
+def _read_config(argv, config, current_name, queue):
     """Read the Sphinx config via multiprocessing for isolation.
 
     :param tuple argv: Arguments to pass to Sphinx.
+    :param sphinxcontrib.versioning.lib.Config config: Runtime configuration.
     :param str current_name: The ref name of the current version being built.
     :param multiprocessing.queues.Queue queue: Communication channel to parent process.
     """
     # Patch.
     EventHandlers.ABORT_AFTER_READ = queue
 
     # Run.
-    _build(argv, Versions(list()), current_name, False)
+    _build(argv, config, Versions(list()), current_name, False)
 
 
 def build(source, target, versions, current_name, is_root):
@@ -222,8 +222,10 @@ def build(source, target, versions, current_name, is_root):
     """
     log = logging.getLogger(__name__)
     argv = ('sphinx-build', source, target)
+    config = Config.from_context()
+
     log.debug('Running sphinx-build for %s with args: %s', current_name, str(argv))
-    child = multiprocessing.Process(target=_build, args=(argv, versions, current_name, is_root))
+    child = multiprocessing.Process(target=_build, args=(argv, config, versions, current_name, is_root))
     child.start()
     child.join()  # Block.
     if child.exitcode != 0:
@@ -244,11 +246,12 @@ def read_config(source, current_name):
     """
     log = logging.getLogger(__name__)
     queue = multiprocessing.Queue()
+    config = Config.from_context()
 
     with TempDir() as temp_dir:
         argv = ('sphinx-build', source, temp_dir)
         log.debug('Running sphinx-build for config values with args: %s', str(argv))
-        child = multiprocessing.Process(target=_read_config, args=(argv, current_name, queue))
+        child = multiprocessing.Process(target=_read_config, args=(argv, config, current_name, queue))
         child.start()
         child.join()  # Block.
         if child.exitcode != 0:

tests/test_routines/test_build_all.py

@@ -1,5 +1,7 @@
 """Test function in module."""
 
+from os.path import join
+
 import pytest
 
 from sphinxcontrib.versioning.git import export
@@ -30,9 +32,9 @@ def test_single(tmpdir, local_docs, urls):
         '_sources',
         '_static',
         'master',
-        'master/.doctrees',
-        'master/_sources',
-        'master/_static',
+        join('master', '.doctrees'),
+        join('master', '_sources'),
+        join('master', '_static'),
     ]
     assert actual == expected
 
@@ -76,20 +78,20 @@ def test_multiple(tmpdir, config, local_docs, run, urls, triple, parallel):
         '_sources',
         '_static',
         'master',
-        'master/.doctrees',
-        'master/_sources',
-        'master/_static',
+        join('master', '.doctrees'),
+        join('master', '_sources'),
+        join('master', '_static'),
         'v1.0.0',
-        'v1.0.0/.doctrees',
-        'v1.0.0/_sources',
-        'v1.0.0/_static',
+        join('v1.0.0', '.doctrees'),
+        join('v1.0.0', '_sources'),
+        join('v1.0.0', '_static'),
     ]
     if triple:
         expected.extend([
             'v1.0.1',
-            'v1.0.1/.doctrees',
-            'v1.0.1/_sources',
-            'v1.0.1/_static',
+            join('v1.0.1', '.doctrees'),
+            join('v1.0.1', '_sources'),
+            join('v1.0.1', '_static'),
         ])
     assert actual == expected
 
@@ -165,8 +167,8 @@ def test_banner_branch(tmpdir, banner, config, local_docs, run, show_banner):
     build_all(str(exported_root), str(dst), versions)
     actual = sorted(f.relto(dst) for f in dst.visit(lambda p: p.basename in ('contents.html', 'one.html', 'two.html')))
     expected = [
-        'contents.html', 'master/contents.html', 'master/one.html',
-        'old_build/contents.html', 'old_build/one.html', 'old_build/two.html', 'one.html'
+        'contents.html', join('master', 'contents.html'), join('master', 'one.html'),
+        join('old_build', 'contents.html'), join('old_build', 'one.html'), join('old_build', 'two.html'), 'one.html'
     ]
     assert actual == expected
 
@@ -241,13 +243,18 @@ def test_banner_tag(tmpdir, banner, config, local_docs, run, recent):
     build_all(str(exported_root), str(dst), versions)
     actual = sorted(f.relto(dst)
                     for f in dst.visit(lambda p: p.basename in ('contents.html', 'one.html', 'two.html', 'too.html')))
-    expected = ['contents.html', 'master/contents.html', 'master/one.html', 'master/too.html', 'one.html', 'too.html']
+    expected = [
+        'contents.html',
+        join('master', 'contents.html'), join('master', 'one.html'), join('master', 'too.html'),
+        'one.html',
+        'too.html',
+    ]
     if recent:
-        expected = ['201612/contents.html', '201612/one.html', '201612/too.html'] + expected
-        expected = ['201611/contents.html', '201611/one.html', '201611/two.html'] + expected
+        expected = [join('201612', 'contents.html'), join('201612', 'one.html'), join('201612', 'too.html')] + expected
+        expected = [join('201611', 'contents.html'), join('201611', 'one.html'), join('201611', 'two.html')] + expected
     else:
-        expected += ['v1.0.0/contents.html', 'v1.0.0/one.html', 'v1.0.0/two.html']
-        expected += ['v2.0.0/contents.html', 'v2.0.0/one.html', 'v2.0.0/too.html']
+        expected += [join('v1.0.0', 'contents.html'), join('v1.0.0', 'one.html'), join('v1.0.0', 'two.html')]
+        expected += [join('v2.0.0', 'contents.html'), join('v2.0.0', 'one.html'), join('v2.0.0', 'too.html')]
     assert actual == expected
 
     # Verify master banner.