Merge pull request #5116 from tk0miya/5114_handle_OSError

Handle OSError on scanning documents (refs: #5114)

CHANGES

@@ -171,6 +171,7 @@ Bugs fixed
 * #4983: productionlist directive generates invalid IDs for the tokens
 * #5132: (lualatex) PDF build fails if indexed word starts with Unicode character
 * #5133: latex: index headings "Symbols" and "Numbers" not internationalized
+* #5114: sphinx-build: Handle errors on scanning documents
 
 Testing
 --------

sphinx/environment/__init__.py

@@ -25,7 +25,7 @@ from sphinx import addnodes
 from sphinx.deprecation import RemovedInSphinx20Warning, RemovedInSphinx30Warning
 from sphinx.environment.adapters.indexentries import IndexEntries
 from sphinx.environment.adapters.toctree import TocTree
-from sphinx.errors import SphinxError, BuildEnvironmentError, ExtensionError
+from sphinx.errors import SphinxError, BuildEnvironmentError, DocumentError, ExtensionError
 from sphinx.locale import __
 from sphinx.transforms import SphinxTransformer
 from sphinx.util import get_matching_docs, FilenameUniqDict
@@ -416,37 +416,40 @@ class BuildEnvironment(object):
         """Find all source files in the source dir and put them in
         self.found_docs.
         """
-        matchers = compile_matchers(
-            config.exclude_patterns[:] +
-            config.templates_path +
-            builder.get_asset_paths() +
-            ['**/_sources', '.#*', '**/.#*', '*.lproj/**']
-        )
-        self.found_docs = set()
-        for docname in get_matching_docs(self.srcdir, config.source_suffix,  # type: ignore
-                                         exclude_matchers=matchers):
-            if os.access(self.doc2path(docname), os.R_OK):
-                self.found_docs.add(docname)
-            else:
-                logger.warning(__("document not readable. Ignored."), location=docname)
+        try:
+            matchers = compile_matchers(
+                config.exclude_patterns[:] +
+                config.templates_path +
+                builder.get_asset_paths() +
+                ['**/_sources', '.#*', '**/.#*', '*.lproj/**']
+            )
+            self.found_docs = set()
+            for docname in get_matching_docs(self.srcdir, config.source_suffix,  # type: ignore
+                                             exclude_matchers=matchers):
+                if os.access(self.doc2path(docname), os.R_OK):
+                    self.found_docs.add(docname)
+                else:
+                    logger.warning(__("document not readable. Ignored."), location=docname)
 
-        # Current implementation is applying translated messages in the reading
-        # phase.Therefore, in order to apply the updated message catalog, it is
-        # necessary to re-process from the reading phase. Here, if dependency
-        # is set for the doc source and the mo file, it is processed again from
-        # the reading phase when mo is updated. In the future, we would like to
-        # move i18n process into the writing phase, and remove these lines.
-        if builder.use_message_catalog:
-            # add catalog mo file dependency
-            for docname in self.found_docs:
-                catalog_files = find_catalog_files(
-                    docname,
-                    self.srcdir,
-                    self.config.locale_dirs,
-                    self.config.language,
-                    self.config.gettext_compact)
-                for filename in catalog_files:
-                    self.dependencies[docname].add(filename)
+            # Current implementation is applying translated messages in the reading
+            # phase.Therefore, in order to apply the updated message catalog, it is
+            # necessary to re-process from the reading phase. Here, if dependency
+            # is set for the doc source and the mo file, it is processed again from
+            # the reading phase when mo is updated. In the future, we would like to
+            # move i18n process into the writing phase, and remove these lines.
+            if builder.use_message_catalog:
+                # add catalog mo file dependency
+                for docname in self.found_docs:
+                    catalog_files = find_catalog_files(
+                        docname,
+                        self.srcdir,
+                        self.config.locale_dirs,
+                        self.config.language,
+                        self.config.gettext_compact)
+                    for filename in catalog_files:
+                        self.dependencies[docname].add(filename)
+        except EnvironmentError as exc:
+            raise DocumentError(__('Failed to scan documents in %s: %r') % (self.srcdir, exc))
 
     def get_outdated_files(self, config_changed):
         # type: (bool) -> Tuple[Set[unicode], Set[unicode], Set[unicode]]

sphinx/errors.py

@@ -82,6 +82,11 @@ class ConfigError(SphinxError):
     category = 'Configuration error'
 
 
+class DocumentError(SphinxError):
+    """Document error."""
+    category = 'Document error'
+
+
 class ThemeError(SphinxError):
     """Theme error."""
     category = 'Theme error'