create models for mkdocs yaml

Author: silentfatez

readthedocs/builds/models.py

@@ -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_yaml_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.

readthedocs/projects/models.py

@@ -39,6 +39,7 @@
 from readthedocs.notifications.models import Notification as NewNotification
 from readthedocs.projects import constants
 from readthedocs.projects.exceptions import ProjectConfigurationError
+from readthedocs.doc_builder.exceptions import MkDocsYAMLParseError
 from readthedocs.projects.managers import HTMLFileManager
 from readthedocs.projects.querysets import (
     ChildRelatedProjectQuerySet,
@@ -971,12 +972,31 @@ def conf_file(self, version=LATEST):
             )
 
         raise ProjectConfigurationError(ProjectConfigurationError.NOT_FOUND)
+    
+
+    def yaml_file(self, version=LATEST):
+        """Find a mkdocs ``mkdocs.yml`` file in the project checkout."""
+        files = self.find("mkdocs.yml", version)
+        if not files:
+            files = self.full_find("mkdocs.yml", version)
+        if len(files) == 1:
+            return files[0]
+        ## TODO Handle for multiple Files
+
+        raise MkDocsYAMLParseError(MkDocsYAMLParseError.NOT_FOUND)
 
     def conf_dir(self, version=LATEST):
         conf_file = self.conf_file(version)
         if conf_file:
             return os.path.dirname(conf_file)
 
+    def yaml_dir(self, version=LATEST):
+        conf_file = self.conf_file(version)
+        if conf_file:
+            return os.path.dirname(conf_file)
+
+
+
     @property
     def has_good_build(self):
         # Check if there is `_good_build` annotation in the Queryset.