Pass config object to builders

Author: stsewd

readthedocs/doc_builder/base.py

@@ -41,11 +41,12 @@ class BaseBuilder(object):
 
     # old_artifact_path = ..
 
-    def __init__(self, build_env, python_env, force=False):
+    def __init__(self, build_env, python_env, config, force=False):
         self.build_env = build_env
         self.python_env = python_env
         self.version = build_env.version
         self.project = build_env.project
+        self.config = config
         self._force = force
         self.target = self.project.artifact_path(
             version=self.version.slug, type_=self.type)

readthedocs/doc_builder/python_environments.py

@@ -274,8 +274,12 @@ 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)
-            docs_dir = (builder_class(build_env=self.build_env, python_env=self)
-                        .docs_dir())
+            builder = builder_class(
+                build_env=self.build_env,
+                python_env=self,
+                config=self.config
+            )
+            docs_dir = builder.docs_dir()
             paths = [docs_dir, '']
             req_files = ['pip_requirements.txt', 'requirements.txt']
             for path, req_file in itertools.product(paths, req_files):

readthedocs/projects/tasks.py

@@ -702,9 +702,10 @@ def build_docs(self):
 
     def build_docs_html(self):
         """Build HTML docs."""
-        html_builder = get_builder_class(self.project.documentation_type)(
+        html_builder = get_builder_class(self.config.doctype)(
             build_env=self.build_env,
             python_env=self.python_env,
+            config=self.config,
         )
         if self.build_force:
             html_builder.force()
@@ -775,7 +776,11 @@ def build_docs_class(self, builder_class):
         only raise a warning exception here. A hard error will halt the build
         process.
         """
-        builder = get_builder_class(builder_class)(self.build_env, python_env=self.python_env)
+        builder = get_builder_class(builder_class)(
+            self.build_env,
+            python_env=self.python_env,
+            config=self.config,
+        )
         success = builder.build()
         builder.move()
         return success

readthedocs/rtd_tests/tests/test_builds.py

@@ -1,7 +1,6 @@
 from __future__ import absolute_import
 
 import mock
-import six
 
 from django.test import TestCase
 from django_dynamic_fixture import get
@@ -11,7 +10,6 @@
 from readthedocs.doc_builder.config import load_yaml_config
 from readthedocs.doc_builder.environments import LocalBuildEnvironment
 from readthedocs.doc_builder.python_environments import Virtualenv
-from readthedocs.doc_builder.loader import get_builder_class
 from readthedocs.projects.tasks import UpdateDocsTaskStep
 from readthedocs.rtd_tests.tests.test_config_integration import create_load
 

readthedocs/rtd_tests/tests/test_doc_builder.py

@@ -6,9 +6,9 @@
 import tempfile
 from collections import namedtuple
 
+import mock
 import pytest
 import yaml
-import mock
 from django.test import TestCase
 from django.test.utils import override_settings
 from django_dynamic_fixture import get
@@ -17,6 +17,7 @@
 from readthedocs.builds.models import Version
 from readthedocs.doc_builder.backends.mkdocs import BaseMkdocs, MkdocsHTML
 from readthedocs.doc_builder.backends.sphinx import BaseSphinx, SearchBuilder
+from readthedocs.doc_builder.config import load_yaml_config
 from readthedocs.projects.exceptions import ProjectConfigurationError
 from readthedocs.projects.models import Project
 
@@ -35,7 +36,12 @@ def setUp(self):
 
         BaseSphinx.type = 'base'
         BaseSphinx.sphinx_build_dir = tempfile.mkdtemp()
-        self.base_sphinx = BaseSphinx(build_env=build_env, python_env=None)
+        config = load_yaml_config(self.version)
+        self.base_sphinx = BaseSphinx(
+            build_env=build_env,
+            python_env=None,
+            config=config,
+        )
 
     @patch(
         'readthedocs.doc_builder.backends.sphinx.SPHINX_TEMPLATE_DIR',
@@ -89,7 +95,12 @@ def setUp(self):
         build_env.project = self.project
         build_env.version = self.version
 
-        self.searchbuilder = SearchBuilder(build_env=build_env, python_env=None)
+        config = load_yaml_config(self.version)
+        self.searchbuilder = SearchBuilder(
+            build_env=build_env,
+            python_env=None,
+            config=config,
+        )
 
     def test_ignore_patterns(self):
         src = tempfile.mkdtemp()
@@ -134,9 +145,11 @@ def test_append_conf_create_yaml(self, checkout_path, run):
         os.mkdir(os.path.join(tmpdir, 'docs'))
         checkout_path.return_value = tmpdir
 
+        config = load_yaml_config(self.version)
         self.searchbuilder = MkdocsHTML(
             build_env=self.build_env,
-            python_env=None
+            python_env=None,
+            config=config,
         )
         self.searchbuilder.append_conf()
 
@@ -189,9 +202,11 @@ def test_append_conf_existing_yaml_on_root(self, checkout_path, run):
         )
         checkout_path.return_value = tmpdir
 
+        config = load_yaml_config(self.version)
         self.searchbuilder = MkdocsHTML(
             build_env=self.build_env,
-            python_env=None
+            python_env=None,
+            config=config,
         )
         self.searchbuilder.append_conf()
 
@@ -243,9 +258,11 @@ def test_override_theme_new_style(self, checkout_path, run):
         )
         checkout_path.return_value = tmpdir
 
+        config = load_yaml_config(self.version)
         self.searchbuilder = MkdocsHTML(
             build_env=self.build_env,
-            python_env=None
+            python_env=None,
+            config=config,
         )
         self.searchbuilder.append_conf()
 
@@ -276,9 +293,11 @@ def test_override_theme_old_style(self, checkout_path, run):
         )
         checkout_path.return_value = tmpdir
 
+        config = load_yaml_config(self.version)
         self.searchbuilder = MkdocsHTML(
             build_env=self.build_env,
-            python_env=None
+            python_env=None,
+            config=config,
         )
         self.searchbuilder.append_conf()
 
@@ -307,9 +326,11 @@ def test_dont_override_theme(self, checkout_path, run):
         )
         checkout_path.return_value = tmpdir
 
+        config = load_yaml_config(self.version)
         self.searchbuilder = MkdocsHTML(
             build_env=self.build_env,
-            python_env=None
+            python_env=None,
+            config=config,
         )
         self.searchbuilder.append_conf()