Adding RTD_ Prefix to Path variables

readthedocs/core/context_processors.py

@@ -13,8 +13,8 @@ def readthedocs_processor(request):
         'USE_SUBDOMAIN': settings.USE_SUBDOMAIN,
         'GLOBAL_ANALYTICS_CODE': settings.GLOBAL_ANALYTICS_CODE,
         'DASHBOARD_ANALYTICS_CODE': settings.DASHBOARD_ANALYTICS_CODE,
-        'SITE_ROOT': settings.SITE_ROOT + '/',
-        'TEMPLATE_ROOT': settings.TEMPLATE_ROOT + '/',
+        'SITE_ROOT': settings.RTD_SITE_ROOT + '/',
+        'TEMPLATE_ROOT': settings.RTD_TEMPLATE_ROOT + '/',
         'DO_NOT_TRACK_ENABLED': settings.DO_NOT_TRACK_ENABLED,
         'USE_PROMOS': settings.USE_PROMOS,
     }

readthedocs/core/symlink.py

@@ -324,7 +324,7 @@ def symlink_single_version(self):
         # Create symlink
         if version is not None:
             docs_dir = os.path.join(
-                settings.DOCROOT,
+                settings.RTD_DOCROOT,
                 self.project.slug,
                 'rtd-builds',
                 version.slug,
@@ -362,7 +362,7 @@ def symlink_versions(self):
             )
             symlink = os.path.join(version_dir, version.slug)
             docs_dir = os.path.join(
-                settings.DOCROOT,
+                settings.RTD_DOCROOT,
                 self.project.slug,
                 'rtd-builds',
                 version.slug,
@@ -386,10 +386,10 @@ def get_default_version(self):
 
 
 class PublicSymlinkBase(Symlink):
-    CNAME_ROOT = os.path.join(settings.SITE_ROOT, 'public_cname_root')
-    WEB_ROOT = os.path.join(settings.SITE_ROOT, 'public_web_root')
+    CNAME_ROOT = os.path.join(settings.RTD_SITE_ROOT, 'public_cname_root')
+    WEB_ROOT = os.path.join(settings.RTD_SITE_ROOT, 'public_web_root')
     PROJECT_CNAME_ROOT = os.path.join(
-        settings.SITE_ROOT,
+        settings.RTD_SITE_ROOT,
         'public_cname_project',
     )
 
@@ -409,10 +409,10 @@ def get_translations(self):
 
 
 class PrivateSymlinkBase(Symlink):
-    CNAME_ROOT = os.path.join(settings.SITE_ROOT, 'private_cname_root')
-    WEB_ROOT = os.path.join(settings.SITE_ROOT, 'private_web_root')
+    CNAME_ROOT = os.path.join(settings.RTD_SITE_ROOT, 'private_cname_root')
+    WEB_ROOT = os.path.join(settings.RTD_SITE_ROOT, 'private_web_root')
     PROJECT_CNAME_ROOT = os.path.join(
-        settings.SITE_ROOT,
+        settings.RTD_SITE_ROOT,
         'private_cname_project',
     )
 

readthedocs/projects/models.py

@@ -651,7 +651,7 @@ def clean_repo(self):
 
     @property
     def doc_path(self):
-        return os.path.join(settings.DOCROOT, self.slug.replace('_', '-'))
+        return os.path.join(settings.RTD_DOCROOT, self.slug.replace('_', '-'))
 
     def checkout_path(self, version=LATEST):
         return os.path.join(self.doc_path, 'checkouts', version)

readthedocs/rtd_tests/base.py

@@ -19,17 +19,17 @@
 
 class RTDTestCase(TestCase):
     def setUp(self):
-        self.original_DOCROOT = settings.DOCROOT
+        self.original_DOCROOT = settings.RTD_DOCROOT
         self.cwd = os.path.dirname(__file__)
         self.build_dir = tempfile.mkdtemp()
         log.info('build dir: %s', self.build_dir)
         if not os.path.exists(self.build_dir):
             os.makedirs(self.build_dir)
-        settings.DOCROOT = self.build_dir
+        settings.RTD_DOCROOT = self.build_dir
 
     def tearDown(self):
         shutil.rmtree(self.build_dir)
-        settings.DOCROOT = self.original_DOCROOT
+        settings.RTD_DOCROOT = self.original_DOCROOT
 
 
 @patch('readthedocs.projects.views.private.trigger_build', lambda x: None)

readthedocs/settings/base.py

@@ -213,25 +213,25 @@ def USE_PROMOS(self):  # noqa
     ]
 
     # Paths
-    SITE_ROOT = os.path.dirname(
+    RTD_SITE_ROOT = os.path.dirname(
         os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
-    TEMPLATE_ROOT = os.path.join(SITE_ROOT, 'readthedocs', 'templates')
-    DOCROOT = os.path.join(SITE_ROOT, 'user_builds')
-    UPLOAD_ROOT = os.path.join(SITE_ROOT, 'user_uploads')
-    CNAME_ROOT = os.path.join(SITE_ROOT, 'cnames')
-    LOGS_ROOT = os.path.join(SITE_ROOT, 'logs')
-    PRODUCTION_ROOT = os.path.join(SITE_ROOT, 'prod_artifacts')
-    PRODUCTION_MEDIA_ARTIFACTS = os.path.join(PRODUCTION_ROOT, 'media')
+    RTD_TEMPLATE_ROOT = os.path.join(RTD_SITE_ROOT, 'readthedocs', 'templates')
+    RTD_DOCROOT = os.path.join(RTD_SITE_ROOT, 'user_builds')
+    RTD_UPLOAD_ROOT = os.path.join(RTD_SITE_ROOT, 'user_uploads')
+    RTD_CNAME_ROOT = os.path.join(RTD_SITE_ROOT, 'cnames')
+    RTD_LOGS_ROOT = os.path.join(RTD_SITE_ROOT, 'logs')
+    RTD_PRODUCTION_ROOT = os.path.join(RTD_SITE_ROOT, 'prod_artifacts')
+    RTD_PRODUCTION_MEDIA_ARTIFACTS = os.path.join(RTD_PRODUCTION_ROOT, 'media')
 
     # Assets and media
-    STATIC_ROOT = os.path.join(SITE_ROOT, 'static')
+    STATIC_ROOT = os.path.join(RTD_SITE_ROOT, 'static')
     STATIC_URL = '/static/'
-    MEDIA_ROOT = os.path.join(SITE_ROOT, 'media/')
+    MEDIA_ROOT = os.path.join(RTD_SITE_ROOT, 'media/')
     MEDIA_URL = '/media/'
     ADMIN_MEDIA_PREFIX = '/media/admin/'
     STATICFILES_DIRS = [
-        os.path.join(SITE_ROOT, 'readthedocs', 'static'),
-        os.path.join(SITE_ROOT, 'media'),
+        os.path.join(RTD_SITE_ROOT, 'readthedocs', 'static'),
+        os.path.join(RTD_SITE_ROOT, 'media'),
     ]
     STATICFILES_FINDERS = [
         'readthedocs.core.static.SelectiveFileSystemFinder',
@@ -246,7 +246,7 @@ def USE_PROMOS(self):  # noqa
     TEMPLATES = [
         {
             'BACKEND': 'django.template.backends.django.DjangoTemplates',
-            'DIRS': [TEMPLATE_ROOT],
+            'DIRS': [RTD_TEMPLATE_ROOT],
             'OPTIONS': {
                 'debug': DEBUG,
                 'context_processors': [
@@ -299,7 +299,7 @@ def USE_PROMOS(self):  # noqa
         ('ko', gettext('Korean')),
     )
     LOCALE_PATHS = [
-        os.path.join(SITE_ROOT, 'readthedocs', 'locale'),
+        os.path.join(RTD_SITE_ROOT, 'readthedocs', 'locale'),
     ]
     USE_I18N = True
     USE_L10N = True
@@ -563,7 +563,7 @@ def USE_PROMOS(self):  # noqa
             'debug': {
                 'level': 'DEBUG',
                 'class': 'logging.handlers.RotatingFileHandler',
-                'filename': os.path.join(LOGS_ROOT, 'debug.log'),
+                'filename': os.path.join(RTD_LOGS_ROOT, 'debug.log'),
                 'formatter': 'default',
             },
             'null': {

readthedocs/settings/dev.py

@@ -17,7 +17,7 @@ def DATABASES(self):  # noqa
         return {
             'default': {
                 'ENGINE': 'django.db.backends.sqlite3',
-                'NAME': os.path.join(self.SITE_ROOT, 'dev.db'),
+                'NAME': os.path.join(self.RTD_SITE_ROOT, 'dev.db'),
             }
         }