From eb6230306fff4dc40f94c22aaef5e4148d71a84d Mon Sep 17 00:00:00 2001 From: Lokesh2703 Date: Wed, 18 Dec 2019 18:57:38 +0530 Subject: [PATCH 1/4] Adding RTD_ Prefix to Path variables --- readthedocs/core/context_processors.py | 4 ++-- readthedocs/core/symlink.py | 12 +++++------ readthedocs/settings/base.py | 30 +++++++++++++------------- readthedocs/settings/dev.py | 2 +- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/readthedocs/core/context_processors.py b/readthedocs/core/context_processors.py index 8f4b17fd9ec..a3164bea6b7 100644 --- a/readthedocs/core/context_processors.py +++ b/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, } diff --git a/readthedocs/core/symlink.py b/readthedocs/core/symlink.py index d8a65ab70ce..c164ebc2ae0 100644 --- a/readthedocs/core/symlink.py +++ b/readthedocs/core/symlink.py @@ -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', ) diff --git a/readthedocs/settings/base.py b/readthedocs/settings/base.py index d8af7992b8c..541dc233e81 100644 --- a/readthedocs/settings/base.py +++ b/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': { diff --git a/readthedocs/settings/dev.py b/readthedocs/settings/dev.py index 6598136d2f6..1f30b89eb15 100644 --- a/readthedocs/settings/dev.py +++ b/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'), } } From 17b53bbbc80c159832e4d8c90a37fee5f877770d Mon Sep 17 00:00:00 2001 From: Lokesh2703 Date: Sat, 21 Dec 2019 12:49:05 +0530 Subject: [PATCH 2/4] Added prefix RTD_ in projects/models.py --- readthedocs/projects/models.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readthedocs/projects/models.py b/readthedocs/projects/models.py index 37aad41a22f..3ccd7b35844 100644 --- a/readthedocs/projects/models.py +++ b/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) From b8821ec499e92ac4b70022ab68f5abfd8e471a28 Mon Sep 17 00:00:00 2001 From: Lokesh2703 Date: Sat, 21 Dec 2019 13:32:05 +0530 Subject: [PATCH 3/4] Added prefix RTD_ to DOCROOT in readthedocs/core/symlink.py --- readthedocs/core/symlink.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/readthedocs/core/symlink.py b/readthedocs/core/symlink.py index c164ebc2ae0..ed7c8f481e1 100644 --- a/readthedocs/core/symlink.py +++ b/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, From 9374fcff529c9851b5d09f42d7e72d27717caac5 Mon Sep 17 00:00:00 2001 From: Lokesh2703 Date: Sat, 21 Dec 2019 15:15:12 +0530 Subject: [PATCH 4/4] Added Prefix RTD_ to DOCROOT in readthedocs/rtd_tests/base.py --- readthedocs/rtd_tests/base.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/readthedocs/rtd_tests/base.py b/readthedocs/rtd_tests/base.py index e7d8f8409e0..16907121eea 100644 --- a/readthedocs/rtd_tests/base.py +++ b/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)