patch sphinx-build script to use terminate with sys.exit(), add extra info to makefile and batchfile.

Author: witekdev

src/collective/recipe/sphinxbuilder/__init__.py

@@ -67,8 +67,8 @@ def install(self):
                         extra_paths.append(filename)
             sys.path.extend(extra_paths)
 
-        from sphinx.quickstart import MAKEFILE
-        from sphinx.quickstart import BATCHFILE
+        from utils import MAKEFILE
+        from utils import BATCHFILE
         from sphinx.util import make_filename
 
         # and cleanup again
@@ -143,6 +143,26 @@ def install(self):
                 self.buildout[self.buildout['buildout']['python']]['executable'],
                 self.bin_dir, **egg_options)
 
+        # patch sphinx-build script
+        # change last line from sphinx.main() to sys.exit(sphinx.main())
+        # so that errors are correctly reported to Travis CI.
+        
+        sb = os.path.join(self.bin_dir, 'sphinx-build')
+        #Create temp file
+        fh, abs_path = mkstemp()
+        new_file = open(abs_path,'w')
+        old_file = open(sb)
+        for line in old_file:
+            new_file.write(line.replace('sphinx.main()', 'sys.exit(sphinx.main())'))
+        #close temp file
+        new_file.close()
+        os.close(fh)
+        old_file.close()
+        #Remove original file
+        os.remove(sb)
+        #Move new file
+        shutil.move(abs_path, sb)
+
         return [self.script_path, self.makefile_path, self.batchfile_path]
 
     update = install

src/collective/recipe/sphinxbuilder/utils.py

@@ -22,6 +22,7 @@
 help:
 \t@echo "Please use \\`make <target>' where <target> is one of"
 \t@echo "  html       to make standalone HTML files"
+\t@echo "  warnings-html to make standalone HTML files (warnings become errors)"
 \t@echo "  dirhtml    to make HTML files named index.html in directories"
 \t@echo "  singlehtml to make a single large HTML file"
 \t@echo "  pickle     to make pickle files"
@@ -185,6 +186,7 @@
 \t:help
 \techo.Please use `make ^<target^>` where ^<target^> is one of
 \techo.  html       to make standalone HTML files
+\techo.  warnings-html to make standalone HTML files (turn warnings into errors)
 \techo.  dirhtml    to make HTML files named index.html in directories
 \techo.  singlehtml to make a single large HTML file
 \techo.  pickle     to make pickle files