Validate docs dir before writing custom js

readthedocs/doc_builder/base.py

@@ -7,6 +7,8 @@
 import shutil
 from functools import wraps
 
+from readthedocs.doc_builder.exceptions import MkDocsYAMLParseError
+
 
 log = logging.getLogger(__name__)
 
@@ -84,6 +86,13 @@ def clean(self, **__):
     def docs_dir(self, docs_dir=None, **__):
         """Handle creating a custom docs_dir if it doesn't exist."""
         checkout_path = self.project.checkout_path(self.version.slug)
+        if docs_dir:
+            possible_path = os.path.join(checkout_path, docs_dir)
+            # if user puts an invalid `docs_dir` path raise Exception
+            if not os.path.exists(possible_path):
+                raise MkDocsYAMLParseError(
+                    MkDocsYAMLParseError.INVALID_DOCS_DIR_PATH,
+                )
         if not docs_dir:
             for doc_dir_name in ['docs', 'doc', 'Doc', 'book']:
                 possible_path = os.path.join(checkout_path, doc_dir_name)

readthedocs/doc_builder/exceptions.py

@@ -67,6 +67,11 @@ class MkDocsYAMLParseError(BuildEnvironmentError):
         'string with relative or absolute path.',
     )
 
+    INVALID_DOCS_DIR_PATH = ugettext_noop(
+        'The "docs_dir" config from your MkDocs YAML config file does not '
+        'contain a valid path.',
+    )
+
     INVALID_EXTRA_CONFIG = ugettext_noop(
         'The "{config}" config from your MkDocs YAML config file has to be a '
         'a list of relative paths.',

readthedocs/rtd_tests/tests/test_doc_builder.py

@@ -488,6 +488,42 @@ def test_write_js_data_docs_dir(self, checkout_path, run, generate_rtd_data):
             mkdocs_config=mock.ANY,
         )
 
+    @patch('readthedocs.doc_builder.backends.mkdocs.BaseMkdocs.generate_rtd_data')
+    @patch('readthedocs.projects.models.Project.checkout_path')
+    def test_write_js_data_on_invalid_docs_dir(self, checkout_path, generate_rtd_data):
+        tmpdir = tempfile.mkdtemp()
+        os.mkdir(os.path.join(tmpdir, 'docs'))
+        yaml_file = os.path.join(tmpdir, 'mkdocs.yml')
+        yaml.safe_dump(
+            {
+                'site_name': 'mkdocs',
+                'google_analytics': ['UA-1234-5', 'mkdocs.org'],
+                'docs_dir': 'invalid_docs_dir',
+                'extra_css': [
+                    'http://readthedocs.org/static/css/badge_only.css'
+                ],
+                'extra_javascript': ['readthedocs-data.js'],
+            },
+            open(yaml_file, 'w'),
+        )
+        checkout_path.return_value = tmpdir
+
+        python_env = Virtualenv(
+            version=self.version,
+            build_env=self.build_env,
+            config=None,
+        )
+        self.searchbuilder = MkdocsHTML(
+            build_env=self.build_env,
+            python_env=python_env,
+        )
+        with self.assertRaises(MkDocsYAMLParseError):
+            self.searchbuilder.append_conf()
+            generate_rtd_data.assert_called_with(
+                docs_dir='docs',
+                mkdocs_config=mock.ANY,
+            )
+
     @patch('readthedocs.doc_builder.base.BaseBuilder.run')
     @patch('readthedocs.projects.models.Project.checkout_path')
     def test_append_conf_existing_yaml_with_extra(self, checkout_path, run):