Merge pull request #6965 from eric-wieser/patch-1

Ensure invoked Sphinx matches importable one
readthedocs · May 4, 2020 · d7e86b3 · d7e86b3
2 parents ecab363 + c25a21b
commit d7e86b3
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/readthedocs/doc_builder/backends/sphinx.py b/readthedocs/doc_builder/backends/sphinx.py
@@ -232,8 +232,7 @@ def build(self):
         self.clean()
         project = self.project
         build_command = [
-            'python',
-            self.python_env.venv_bin(filename='sphinx-build'),
+            *self.get_sphinx_cmd(),
             '-T',
         ]
         if self._force:
@@ -259,6 +258,18 @@ def build(self):
         )
         return cmd_ret.successful
 
+    def get_sphinx_cmd(self):
+        if self.project.has_feature(Feature.FORCE_SPHINX_FROM_VENV):
+            return (
+                self.python_env.venv_bin(filename='python'),
+                '-m',
+                'sphinx',
+            )
+        return (
+            'python',
+            self.python_env.venv_bin(filename='sphinx-build'),
+        )
+
     def venv_sphinx_supports_latexmk(self):
         """
         Check if ``sphinx`` from the user's venv supports ``latexmk``.
@@ -434,8 +445,7 @@ def build(self):
 
         # Default to this so we can return it always.
         self.run(
-            'python',
-            self.python_env.venv_bin(filename='sphinx-build'),
+            *self.get_sphinx_cmd(),
             '-b',
             'latex',
             '-D',

diff --git a/readthedocs/projects/models.py b/readthedocs/projects/models.py
@@ -1584,6 +1584,7 @@ def add_features(sender, **kwargs):
     CACHED_ENVIRONMENT = 'cached_environment'
     CELERY_ROUTER = 'celery_router'
     LIMIT_CONCURRENT_BUILDS = 'limit_concurrent_builds'
+    FORCE_SPHINX_FROM_VENV = 'force_sphinx_from_venv'
     LIST_PACKAGES_INSTALLED_ENV = 'list_packages_installed_env'
     VCS_REMOTE_LISTING = 'vcs_remote_listing'
 
@@ -1664,6 +1665,10 @@ def add_features(sender, **kwargs):
             LIMIT_CONCURRENT_BUILDS,
             _('Limit the amount of concurrent builds'),
         ),
+        (
+            FORCE_SPHINX_FROM_VENV,
+            _('Force to use Sphinx from the current virtual environment'),
+        ),
         (
             LIST_PACKAGES_INSTALLED_ENV,
             _(