Merge branch 'build-pdf-ret-val'

Author: agjohnson

readthedocs/doc_builder/backends/sphinx.py

@@ -17,6 +17,7 @@
 
 from ..base import BaseBuilder, restoring_chdir
 from ..exceptions import BuildEnvironmentError
+from ..environments import BuildCommand
 
 
 log = logging.getLogger(__name__)
@@ -225,6 +226,17 @@ def move(self, **kwargs):
             self.run('mv', '-f', from_file, to_file)
 
 
+class LatexBuildCommand(BuildCommand):
+    '''Ignore LaTeX exit code if there was file output'''
+
+    def run(self):
+        super(LatexBuildCommand, self).run()
+        # Force LaTeX exit code to be a little more optimistic. If LaTeX
+        # reports an output file, let's just assume we're fine.
+        if PDF_RE.search(self.output):
+            self.exit_code = 0
+
+
 class PdfBuilder(BaseSphinx):
     type = 'sphinx_pdf'
     sphinx_build_dir = '_build/latex'
@@ -268,20 +280,18 @@ def build(self, **kwargs):
 
         pdf_commands = []
         for cmd in pdflatex_cmds:
-            cmd_ret = self.run(*cmd, cwd=latex_cwd, warn_only=True)
-            # Force LaTeX exit code to be a little more optimistic. If LaTeX
-            # reports an output file, let's just assume we're fine.
-            if PDF_RE.search(cmd_ret.output):
-                cmd_ret.exit_code = 0
+            cmd_ret = self.build_env.run_command_class(
+                cls=LatexBuildCommand, cmd=cmd, cwd=latex_cwd, warn_only=True)
             pdf_commands.append(cmd_ret)
         for cmd in makeindex_cmds:
-            cmd_ret = self.run(*cmd, cwd=latex_cwd, warn_only=True)
+            cmd_ret = self.build_env.run_command_class(
+                cls=LatexBuildCommand, cmd=cmd, cwd=latex_cwd, warn_only=True)
             pdf_commands.append(cmd_ret)
         for cmd in pdflatex_cmds:
-            cmd_ret = self.run(*cmd, cwd=latex_cwd, warn_only=True)
+            cmd_ret = self.build_env.run_command_class(
+                cls=LatexBuildCommand, cmd=cmd, cwd=latex_cwd, warn_only=True)
             pdf_match = PDF_RE.search(cmd_ret.output)
             if pdf_match:
-                cmd_ret.exit_code = 0
                 self.pdf_file_name = pdf_match.group(1).strip()
             pdf_commands.append(cmd_ret)
         return all(cmd.successful for cmd in pdf_commands)

readthedocs/doc_builder/environments.py

@@ -300,25 +300,31 @@ def handle_exception(self, exc_type, exc_value, _):
                 return False
 
     def run(self, *cmd, **kwargs):
-        '''Run command from environment
+        '''Shortcut to run command from environment'''
+        return self.run_command_class(cls=self.command_class, cmd=cmd, **kwargs)
+
+    def run_command_class(self, cls, cmd, **kwargs):
+        '''Run command from this environment
+
+        Use ``cls`` to instantiate a command
 
         :param warn_only: Don't raise an exception on command failure
         '''
         warn_only = kwargs.pop('warn_only', False)
         kwargs['build_env'] = self
-        cmd = self.command_class(cmd, **kwargs)
-        self.commands.append(cmd)
-        cmd.run()
+        build_cmd = cls(cmd, **kwargs)
+        self.commands.append(build_cmd)
+        build_cmd.run()
 
         # Save to database
         if self.record:
-            cmd.save()
+            build_cmd.save()
 
-        if cmd.failed:
-            msg = u'Command {cmd} failed'.format(cmd=cmd.get_command())
+        if build_cmd.failed:
+            msg = u'Command {cmd} failed'.format(cmd=build_cmd.get_command())
 
-            if cmd.output:
-                msg += u':\n{out}'.format(out=cmd.output)
+            if build_cmd.output:
+                msg += u':\n{out}'.format(out=build_cmd.output)
 
             if warn_only:
                 log.warn(LOG_TEMPLATE
@@ -327,7 +333,7 @@ def run(self, *cmd, **kwargs):
                                  msg=msg))
             else:
                 raise BuildEnvironmentWarning(msg)
-        return cmd
+        return build_cmd
 
     @property
     def successful(self):