Implement mkdocs key from v2 config

readthedocs/config/config.py

@@ -11,13 +11,22 @@
 
 import six
 
+from readthedocs.projects.constants import DOCUMENTATION_CHOICES
+
 from .find import find_one
 from .models import Build, Conda, Mkdocs, Python, Sphinx, Submodules
 from .parser import ParseError, parse
 from .validation import (
-    ValidationError, validate_bool, validate_choice, validate_dict,
-    validate_directory, validate_file, validate_list, validate_string,
-    validate_value_exists)
+    ValidationError,
+    validate_bool,
+    validate_choice,
+    validate_dict,
+    validate_directory,
+    validate_file,
+    validate_list,
+    validate_string,
+    validate_value_exists,
+)
 
 __all__ = (
     'ALL',
@@ -138,7 +147,7 @@ def __init__(self, env_config, raw_config, source_file, source_position):
     def error(self, key, message, code):
         """Raise an error related to ``key``."""
         source = '{file} [{pos}]'.format(
-            file=self.source_file,
+            file=os.path.relpath(self.source_file, self.base_path),
             pos=self.source_position,
         )
         error_message = '{source}: {message}'.format(
@@ -533,6 +542,13 @@ def sphinx(self):
             fail_on_warning=False,
         )
 
+    @property
+    def mkdocs(self):
+        return Mkdocs(
+            configuration=None,
+            fail_on_warning=False,
+        )
+
 
 class BuildConfigV2(BuildConfigBase):
 
@@ -548,6 +564,7 @@ class BuildConfigV2(BuildConfigBase):
         'htmldir': 'sphinx_htmldir',
         'singlehtml': 'sphinx_singlehtml',
     }
+    builders_display = dict(DOCUMENTATION_CHOICES)
 
     def validate(self):
         """
@@ -566,6 +583,8 @@ def validate(self):
         self.validate_doc_types()
         self._config['mkdocs'] = self.validate_mkdocs()
         self._config['sphinx'] = self.validate_sphinx()
+        # TODO: remove later
+        self.validate_final_doc_type()
         self._config['submodules'] = self.validate_submodules()
 
     def validate_formats(self):
@@ -806,6 +825,30 @@ def validate_sphinx(self):
 
         return sphinx
 
+    def validate_final_doc_type(self):
+        """
+        Validates that the doctype is the same as the admin panel.
+
+        This a temporal validation, as the configuration file
+        should support per version doctype, but we need to
+        adapt the rtd code for that.
+        """
+        dashboard_doctype = self.defaults.get('doctype', 'sphinx')
+        if self.doctype != dashboard_doctype:
+            error_msg = (
+                'Your project is configured as "{}" in your admin dashboard,'
+            ).format(self.builders_display[dashboard_doctype])
+
+            if dashboard_doctype == 'mkdocs' or not self.sphinx:
+                error_msg += ' but there is no "{}" key specified.'.format(
+                    'mkdocs' if dashboard_doctype == 'mkdocs' else 'sphinx'
+                )
+            else:
+                error_msg += ' but your "sphinx.builder" key does not match.'
+
+            key = 'mkdocs' if self.doctype == 'mkdocs' else 'sphinx.builder'
+            self.error(key, error_msg, code=INVALID_KEYS_COMBINATION)
+
     def validate_submodules(self):
         """
         Validates the submodules key.

readthedocs/config/tests/test_config.py

@@ -1316,7 +1316,10 @@ def test_sphinx_is_default_doc_type(self):
                               ('htmldir', 'sphinx_htmldir'),
                               ('singlehtml', 'sphinx_singlehtml')])
     def test_sphinx_builder_check_valid(self, value, expected):
-        build = self.get_build_config({'sphinx': {'builder': value}})
+        build = self.get_build_config(
+            {'sphinx': {'builder': value}},
+            {'defaults': {'doctype': expected}},
+        )
         build.validate()
         assert build.sphinx.builder == expected
         assert build.doctype == expected
@@ -1333,6 +1336,8 @@ def test_sphinx_builder_default(self):
         build.validate()
         build.sphinx.builder == 'sphinx'
 
+    @pytest.mark.skip(
+        'This test is not compatible with the new validation around doctype.')
     def test_sphinx_builder_ignores_default(self):
         build = self.get_build_config(
             {},
@@ -1454,6 +1459,7 @@ def test_mkdocs_configuration_check_valid(self, tmpdir):
         apply_fs(tmpdir, {'mkdocs.yml': ''})
         build = self.get_build_config(
             {'mkdocs': {'configuration': 'mkdocs.yml'}},
+            {'defaults': {'doctype': 'mkdocs'}},
             source_file=str(tmpdir.join('readthedocs.yml')),
         )
         build.validate()
@@ -1472,40 +1478,80 @@ def test_mkdocs_configuration_check_invalid(self, tmpdir):
         assert excinfo.value.key == 'mkdocs.configuration'
 
     def test_mkdocs_configuration_allow_null(self):
-        build = self.get_build_config({'mkdocs': {'configuration': None}},)
+        build = self.get_build_config(
+            {'mkdocs': {'configuration': None}},
+            {'defaults': {'doctype': 'mkdocs'}},
+        )
         build.validate()
         assert build.mkdocs.configuration is None
 
     def test_mkdocs_configuration_check_default(self):
-        build = self.get_build_config({'mkdocs': {}})
+        build = self.get_build_config(
+            {'mkdocs': {}},
+            {'defaults': {'doctype': 'mkdocs'}},
+        )
         build.validate()
         assert build.mkdocs.configuration is None
 
     @pytest.mark.parametrize('value', [[], True, 0, {}])
     def test_mkdocs_configuration_validate_type(self, value):
-        build = self.get_build_config({'mkdocs': {'configuration': value}},)
+        build = self.get_build_config(
+            {'mkdocs': {'configuration': value}},
+            {'defaults': {'doctype': 'mkdocs'}},
+        )
         with raises(InvalidConfig) as excinfo:
             build.validate()
         assert excinfo.value.key == 'mkdocs.configuration'
 
     @pytest.mark.parametrize('value', [True, False])
     def test_mkdocs_fail_on_warning_check_valid(self, value):
-        build = self.get_build_config({'mkdocs': {'fail_on_warning': value}})
+        build = self.get_build_config(
+            {'mkdocs': {'fail_on_warning': value}},
+            {'defaults': {'doctype': 'mkdocs'}},
+        )
         build.validate()
         assert build.mkdocs.fail_on_warning is value
 
     @pytest.mark.parametrize('value', [[], 'invalid', 5])
     def test_mkdocs_fail_on_warning_check_invalid(self, value):
-        build = self.get_build_config({'mkdocs': {'fail_on_warning': value}})
+        build = self.get_build_config(
+            {'mkdocs': {'fail_on_warning': value}},
+            {'defaults': {'doctype': 'mkdocs'}},
+        )
         with raises(InvalidConfig) as excinfo:
             build.validate()
         assert excinfo.value.key == 'mkdocs.fail_on_warning'
 
     def test_mkdocs_fail_on_warning_check_default(self):
-        build = self.get_build_config({'mkdocs': {}})
+        build = self.get_build_config(
+            {'mkdocs': {}},
+            {'defaults': {'doctype': 'mkdocs'}},
+        )
         build.validate()
         assert build.mkdocs.fail_on_warning is False
 
+    def test_validates_different_filetype_mkdocs(self):
+        build = self.get_build_config(
+            {'mkdocs': {}},
+            {'defaults': {'doctype': 'sphinx'}},
+        )
+        with raises(InvalidConfig) as excinfo:
+            build.validate()
+        assert excinfo.value.key == 'mkdocs'
+        assert 'configured as "Sphinx Html"' in str(excinfo.value)
+        assert 'there is no "sphinx" key' in str(excinfo.value)
+
+    def test_validates_different_filetype_sphinx(self):
+        build = self.get_build_config(
+            {'sphinx': {}},
+            {'defaults': {'doctype': 'sphinx_htmldir'}},
+        )
+        with raises(InvalidConfig) as excinfo:
+            build.validate()
+        assert excinfo.value.key == 'sphinx.builder'
+        assert 'configured as "Sphinx HtmlDir"' in str(excinfo.value)
+        assert 'your "sphinx.builder" key does not match' in str(excinfo.value)
+
     @pytest.mark.parametrize('value', [[], 'invalid', 0])
     def test_submodules_check_invalid_type(self, value):
         build = self.get_build_config({'submodules': value})

readthedocs/doc_builder/backends/mkdocs.py

@@ -52,14 +52,15 @@ def __init__(self, *args, **kwargs):
 
     def get_yaml_config(self):
         """Find the ``mkdocs.yml`` file in the project root."""
-        # TODO: try to load from the configuration file first.
-        test_path = os.path.join(
-            self.project.checkout_path(self.version.slug),
-            'mkdocs.yml'
-        )
-        if os.path.exists(test_path):
-            return test_path
-        return None
+        mkdoc_path = self.config.mkdocs.configuration
+        if not mkdoc_path:
+            mkdoc_path = os.path.join(
+                self.project.checkout_path(self.version.slug),
+                'mkdocs.yml'
+            )
+            if not os.path.exists(mkdoc_path):
+                return None
+        return mkdoc_path
 
     def load_yaml_config(self):
         """
@@ -184,6 +185,8 @@ def build(self):
             '--site-dir', self.build_dir,
             '--config-file', self.yaml_file,
         ]
+        if self.config.mkdocs.fail_on_warning:
+            build_command.append('--strict')
         cmd_ret = self.run(
             *build_command,
             cwd=checkout_path,

readthedocs/doc_builder/python_environments.py

@@ -236,7 +236,7 @@ def install_core_requirements(self):
             'recommonmark==0.4.0',
         ]
 
-        if self.project.documentation_type == 'mkdocs':
+        if self.config.doctype == 'mkdocs':
             requirements.append('mkdocs==0.17.3')
         else:
             # We will assume semver here and only automate up to the next
@@ -275,7 +275,7 @@ def install_core_requirements(self):
     def install_user_requirements(self):
         requirements_file_path = self.config.python.requirements
         if not requirements_file_path and requirements_file_path != '':
-            builder_class = get_builder_class(self.project.documentation_type)
+            builder_class = get_builder_class(self.config.doctype)
             docs_dir = (builder_class(build_env=self.build_env, python_env=self)
                         .docs_dir())
             paths = [docs_dir, '']
@@ -352,7 +352,7 @@ def install_core_requirements(self):
             'recommonmark',
         ]
 
-        if self.project.documentation_type == 'mkdocs':
+        if self.config.doctype == 'mkdocs':
             pip_requirements.append('mkdocs')
         else:
             pip_requirements.append('readthedocs-sphinx-ext')

readthedocs/projects/models.py

@@ -318,6 +318,11 @@ def save(self, *args, **kwargs):  # pylint: disable=arguments-differ
             self.slug = slugify(self.name)
             if self.slug == '':
                 raise Exception(_('Model must have slug'))
+        if self.documentation_type == 'auto':
+            # This used to determine the type and automatically set the
+            # documentation type to Sphinx for rST and Mkdocs for markdown.
+            # It now just forces Sphinx, due to markdown support.
+            self.documentation_type = 'sphinx'
         super(Project, self).save(*args, **kwargs)
         for owner in self.users.all():
             assign('view_project', owner, self)
@@ -590,16 +595,6 @@ def conf_dir(self, version=LATEST):
         if conf_file:
             return os.path.dirname(conf_file)
 
-    @property
-    def is_type_sphinx(self):
-        """Is project type Sphinx."""
-        return 'sphinx' in self.documentation_type
-
-    @property
-    def is_type_mkdocs(self):
-        """Is project type Mkdocs."""
-        return 'mkdocs' in self.documentation_type
-
     @property
     def is_imported(self):
         return bool(self.repo)