rework get_mkdocs_yaml_path

Author: silentfatez

readthedocs/builds/models.py

@@ -1,5 +1,4 @@
 """Models for the builds app."""
-
 import datetime
 import os.path
 import re
@@ -86,6 +85,7 @@
 
 
 class Version(TimeStampedModel):
+
     """Version of a ``Project``."""
 
     project = models.ForeignKey(
@@ -540,6 +540,12 @@ def get_conf_py_path(self):
         conf_py_path = os.path.relpath(conf_py_path, checkout_prefix)
         return conf_py_path
 
+    def get_mkdocs_yml_path(self):
+        mkdocs_yml_path = self.project.yaml_dir(self.slug)
+        checkout_prefix = self.project.checkout_path(self.slug)
+        mkdocs_yml_path = os.path.relpath(mkdocs_yml_path, checkout_prefix)
+        return mkdocs_yml_path
+
     def get_storage_paths(self, version_slug=None):
         """
         Return a list of all build artifact storage paths for this version.
@@ -567,6 +573,7 @@ def get_storage_paths(self, version_slug=None):
 
 
 class APIVersion(Version):
+
     """
     Version proxy model for API data deserialization.
 
@@ -618,6 +625,7 @@ def save(self, *args, **kwargs):
 
 
 class Build(models.Model):
+
     """Build data."""
 
     project = models.ForeignKey(
@@ -1013,6 +1021,7 @@ def reset(self):
 
 
 class BuildCommandResultMixin:
+
     """
     Mixin for common command result methods/properties.
 
@@ -1036,6 +1045,7 @@ def failed(self):
 
 
 class BuildCommandResult(BuildCommandResultMixin, models.Model):
+
     """Build command for a ``Build``."""
 
     build = models.ForeignKey(
@@ -1068,6 +1078,7 @@ def run_time(self):
 
 
 class VersionAutomationRule(PolymorphicModel, TimeStampedModel):
+    
     """Versions automation rules for projects."""
 
     ACTIVATE_VERSION_ACTION = "activate-version"

readthedocs/rtd_tests/tests/test_doc_builder.py

@@ -128,7 +128,7 @@ def setUp(self):
         self.build_env.project = self.project
         self.build_env.version = self.version
         self.build_env.build = {
-            "id": 123,
+            "id": 456,
         }
         self.build_env.api_client = mock.MagicMock()
 
@@ -145,7 +145,7 @@ def test_project_without_mkdocs_yaml(
         self,
         load_yaml_config,
         checkout_path,
-        get_mkdocs_yaml_path,
+        get_mkdocs_yml_path,
         _,
         docs_dir,
     ):
@@ -158,7 +158,7 @@ def test_project_without_mkdocs_yaml(
         tmp_dir = tempfile.mkdtemp()
         checkout_path.return_value = tmp_dir
         docs_dir.return_value = tmp_dir
-        get_mkdocs_yaml_path.side_effect = MkDocsYAMLParseError
+        get_mkdocs_yml_path.side_effect = MkDocsYAMLParseError
         python_env = Virtualenv(
             version=self.version,
             build_env=self.build_env,