docs: annotate comprehensive theming settings

This commit is contained in:
Manjinder Singh
2021-01-27 07:23:19 -05:00
committed by Sofiane Bebert
parent 36d4c712c3
commit a5e3675ce2
4 changed files with 45 additions and 11 deletions

View File

@@ -8,6 +8,7 @@ import os
import six
from django.conf import settings
from django.core.checks import Error, Tags, register
from edx_toggles.toggles import SettingToggle
@register(Tags.compatibility)
@@ -24,7 +25,7 @@ def check_comprehensive_theme_settings(app_configs, **kwargs): # lint-amnesty,
Returns:
List of any Errors.
"""
if not getattr(settings, "ENABLE_COMPREHENSIVE_THEMING"): # lint-amnesty, pylint: disable=literal-used-as-attribute
if not SettingToggle("ENABLE_COMPREHENSIVE_THEMING", default=False).is_enabled():
# Only perform checks when comprehensive theming is enabled.
return []

View File

@@ -13,6 +13,7 @@ from logging import getLogger
import crum
from django.conf import settings
from edx_toggles.toggles import SettingToggle
from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
from openedx.core.djangoapps.theming.helpers_dirs import (
Theme,
@@ -315,10 +316,12 @@ def is_comprehensive_theming_enabled():
Returns:
(bool): True if comprehensive theming is enabled else False
"""
if settings.ENABLE_COMPREHENSIVE_THEMING and current_request_has_associated_site_theme():
ENABLE_COMPREHENSIVE_THEMING = SettingToggle("ENABLE_COMPREHENSIVE_THEMING", default=False)
if ENABLE_COMPREHENSIVE_THEMING.is_enabled() and current_request_has_associated_site_theme():
return True
return settings.ENABLE_COMPREHENSIVE_THEMING
return ENABLE_COMPREHENSIVE_THEMING.is_enabled()
def get_config_value_from_site_or_settings(name, site=None, site_config_name=None):