Fixing make docs

Adding constraint on sphinx.
openedx · Dec 29, 2020 · e5790db · e5790db
1 parent e19f474
commit e5790db
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/common/djangoapps/third_party_auth/provider.py b/common/djangoapps/third_party_auth/provider.py
@@ -7,7 +7,7 @@
 
 from openedx.core.djangoapps.theming.helpers import get_current_request
 
-from .models import (
+from common.djangoapps.third_party_auth.models import (
     _LTI_BACKENDS,
     _PSA_OAUTH2_BACKENDS,
     _PSA_SAML_BACKENDS,

diff --git a/docs/guides/conf.py b/docs/guides/conf.py
@@ -255,6 +255,17 @@
         modules[path] = path
 
 
+# These Django apps under lms don't import correctly with the "lms.djangapps" prefix
+# Others don't import correctly without it...INSTALLED_APPS entries are inconsistent
+lms_djangoapps = ['badges', 'branding', 'bulk_email', 'courseware',
+                  'coursewarehistoryextended', 'email_marketing', 'experiments', 'lti_provider',
+                  'mobile_api', 'notes', 'rss_proxy', 'shoppingcart', 'survey']
+for app in lms_djangoapps:
+    path = os.path.join('lms', 'djangoapps', app)
+    if app not in ['notes']:
+        modules[path] = path
+
+
 def update_settings_module(service='lms'):
     """
     Set the "DJANGO_SETTINGS_MODULE" environment variable appropriately
@@ -283,6 +294,7 @@ def on_init(app):  # pylint: disable=unused-argument
     exclude_dirs = ['envs', 'migrations', 'test', 'tests']
     exclude_dirs.extend(cms_djangoapps)
     exclude_dirs.extend(lms_djangoapps)
+
     exclude_files = ['admin.py', 'test.py', 'testing.py', 'tests.py', 'testutils.py', 'wsgi.py']
     for module in modules:
         module_path = six.text_type(root / module)
@@ -315,5 +327,5 @@ def on_init(app):  # pylint: disable=unused-argument
 
 def setup(app):
     """Sphinx extension: run sphinx-apidoc."""
-    event = b'builder-inited' if six.PY2 else 'builder-inited'
+    event = 'builder-inited'
     app.connect(event, on_init)
diff --git a/lms/envs/devstack_docker.py b/lms/envs/devstack_docker.py
@@ -7,3 +7,4 @@
 """
 
 from .devstack import *  # pylint: disable=wildcard-import, unused-wildcard-import
+COMMON_TEST_DATA_ROOT = ''
diff --git a/requirements/constraints.txt b/requirements/constraints.txt
@@ -136,3 +136,6 @@ sympy==1.6.2
 
 # cryptography 3.3.1 started failing tests on sandbox because it dropped support for python3.5
 cryptography==3.2.1
+
+# greater versions breaking the code
+sphinx==3.3.3
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@
		"""

		from .devstack import * # pylint: disable=wildcard-import, unused-wildcard-import
		COMMON_TEST_DATA_ROOT = ''