Fixing make docs issue #25799

awais786 · 2020-12-08T11:22:25Z

make docs command fixed in this PR.

Added constraint 3.3.4 was giving error.
sphinx-doc/sphinx#8568

Ticket added for tracking here

HTML generated

awais786 · 2020-12-08T11:23:25Z

docs/guides/conf.py

@@ -282,7 +282,7 @@ def on_init(app):  # pylint: disable=unused-argument
        apidoc_path = os.path.join(bin_path, apidoc_path)
    exclude_dirs = ['envs', 'migrations', 'test', 'tests']
    exclude_dirs.extend(cms_djangoapps)
-    exclude_dirs.extend(lms_djangoapps)


lms_djangoapps was removed in this commit.
but its reference remains.

I suspect we can rip out all this out pretty soon, but probably best to wait until the sys.path hack removal is fully complete.

awais786 · 2020-12-08T11:25:11Z

Latest issue is coming due to event_routing_backends

Running Sphinx v3.3.1

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/sphinx/config.py", line 319, in eval_config_file
    execfile_(filename, namespace)
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/sphinx/util/pycompat.py", line 89, in execfile_
    exec(code, _globals)
  File "/edx/app/edxapp/edx-platform/docs/guides/conf.py", line 43, in <module>
    django.setup()
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/__init__.py", line 24, in setup
    apps.populate(settings.INSTALLED_APPS)
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/apps/registry.py", line 122, in populate
    app_config.ready()
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/event_routing_backends/apps.py", line 21, in ready
    from event_routing_backends.processors.caliper import event_transformers
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/event_routing_backends/processors/caliper/event_transformers/__init__.py", line 4, in <module>
    from event_routing_backends.processors.caliper.event_transformers.enrollment_events import EnrollmentEventTransformers
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/event_routing_backends/processors/caliper/event_transformers/enrollment_events.py", line 8, in <module>
    from event_routing_backends.processors.caliper.transformer import CaliperTransformer
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/event_routing_backends/processors/caliper/transformer.py", line 12, in <module>
    from student.models import anonymous_id_for_user  # pylint: disable=import-error
  File "/edx/app/edxapp/edx-platform/common/djangoapps/student/models.py", line 130, in <module>
    class AnonymousUserId(models.Model):
  File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/db/models/base.py", line 108, in __new__
    raise RuntimeError(
RuntimeError: Model class student.models.AnonymousUserId doesn't declare an explicit app_label and isn't in an application in INSTALLED_APPS.

jmbowman · 2020-12-10T15:29:10Z

docs/guides/conf.py

@@ -282,7 +282,7 @@ def on_init(app):  # pylint: disable=unused-argument
        apidoc_path = os.path.join(bin_path, apidoc_path)
    exclude_dirs = ['envs', 'migrations', 'test', 'tests']
    exclude_dirs.extend(cms_djangoapps)
-    exclude_dirs.extend(lms_djangoapps)


I suspect we can rip out all this out pretty soon, but probably best to wait until the sys.path hack removal is fully complete.

awais786 · 2020-12-10T19:49:34Z

make docs still failing. I have added a complete traceback ^^

jmbowman · 2020-12-21T20:06:53Z

The issue with event_routing_backends has been fixed on master, but after rebasing I now get a similar error in edx-enterprise. This is all due to the sys.path hacks, maybe we should just wait to fix the docs command until the removal of those is complete?

awais786 · 2020-12-29T18:56:08Z

docs/docs_settings.py

@@ -41,6 +41,8 @@
    'contentstore.apps.ContentstoreConfig',
    'cms.djangoapps.course_creators',
    'xblock_config.apps.XBlockConfig',
-    'user_tasks',


Defined in lms/envs/common.py also.

Yeah, Dave added that just 2 weeks ago in https://github.com/edx/edx-platform/pull/25933 .

awais786 · 2020-12-30T18:24:31Z

docs/docs_settings.py

    'lms.djangoapps.lti_provider'
 ])
+
+
+COMMON_TEST_DATA_ROOT = ''


Otherwise undefined var error appeared.

awais786 · 2020-12-31T13:03:51Z

jenkins run python

awais786 · 2020-12-31T13:05:07Z

jenkins run all

awais786 · 2020-12-31T15:46:48Z

jenkins run all

awais786 · 2021-01-05T16:26:01Z

@jmbowman Please review.

Adding constraint on sphinx.

jmbowman · 2021-01-05T18:55:34Z

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


Could you please write a ticket summarizing the problem with newer versions and link to it from here? Also, it looks like the docs requirements file hasn't been updated accordingly.

Yes, its due to conflicts. make upgrade in progress right now.

jmbowman · 2021-01-05T18:58:00Z

docs/docs_settings.py

@@ -41,6 +41,8 @@
    'contentstore.apps.ContentstoreConfig',
    'cms.djangoapps.course_creators',
    'xblock_config.apps.XBlockConfig',
-    'user_tasks',


Yeah, Dave added that just 2 weeks ago in https://github.com/edx/edx-platform/pull/25933 .

jmbowman · 2021-01-05T19:02:59Z

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 (


I think this should be harmless, but why was it needed?

it was giving error during make docs command. I will add the complete traceback

@jmbowman Otherwise this error appears

Configuration error: There is a programmable error in your configuration file: Traceback (most recent call last): File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/sphinx/config.py", line 319, in eval_config_file execfile_(filename, namespace) File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/sphinx/util/pycompat.py", line 89, in execfile_ exec(code, _globals) File "/edx/app/edxapp/edx-platform/docs/guides/conf.py", line 43, in <module> django.setup() File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/__init__.py", line 24, in setup apps.populate(settings.INSTALLED_APPS) File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/apps/registry.py", line 114, in populate app_config.import_models() File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/apps/config.py", line 211, in import_models self.models_module = import_module(models_module_name) File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/importlib/__init__.py", line 127, in import_module return _bootstrap._gcd_import(name[level:], package, level) File "<frozen importlib._bootstrap>", line 1014, in _gcd_import File "<frozen importlib._bootstrap>", line 991, in _find_and_load File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked File "<frozen importlib._bootstrap>", line 671, in _load_unlocked File "<frozen importlib._bootstrap_external>", line 783, in exec_module File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/integrated_channels/sap_success_factors/models.py", line 18, in <module> from integrated_channels.sap_success_factors.exporters.learner_data import ( File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/integrated_channels/sap_success_factors/exporters/learner_data.py", line 14, in <module> from enterprise.tpa_pipeline import get_user_from_social_auth File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/enterprise/tpa_pipeline.py", line 23, in <module> from third_party_auth.provider import Registry File "/edx/app/edxapp/edx-platform/common/djangoapps/third_party_auth/provider.py", line 10, in <module> from .models import ( File "/edx/app/edxapp/edx-platform/common/djangoapps/third_party_auth/models.py", line 338, in <module> class OAuth2ProviderConfig(ProviderConfig): File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/db/models/base.py", line 316, in __new__ new_class._meta.apps.register_model(new_class._meta.app_label, new_class) File "/edx/app/edxapp/venvs/edxapp/lib/python3.8/site-packages/django/apps/registry.py", line 227, in register_model raise RuntimeError( RuntimeError: Conflicting 'oauth2providerconfig' models in application 'third_party_auth': <class 'common.djangoapps.third_party_auth.models.OAuth2ProviderConfig'> and <class 'third_party_auth.models.OAuth2ProviderConfig'>.

edx-status-bot · 2021-01-05T20:42:34Z

Your PR has finished running tests. There were no failures.

edx-pipeline-bot · 2021-01-05T21:21:06Z

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

edx-pipeline-bot · 2021-01-05T21:56:42Z

EdX Release Notice: This PR has been deployed to the production environment.

awais786 commented Dec 8, 2020

View reviewed changes

awais786 requested a review from jmbowman December 9, 2020 15:25

jmbowman approved these changes Dec 10, 2020

View reviewed changes

awais786 force-pushed the awais786/make-docs branch from 325aaac to e5790db Compare December 29, 2020 11:02

awais786 requested a review from jmbowman December 29, 2020 11:35

awais786 force-pushed the awais786/make-docs branch 2 times, most recently from d7f8a67 to 706757f Compare December 29, 2020 18:31

awais786 commented Dec 29, 2020

View reviewed changes

awais786 marked this pull request as ready for review December 30, 2020 06:46

awais786 commented Dec 30, 2020

View reviewed changes

awais786 force-pushed the awais786/make-docs branch from 5f4d7eb to 9c66a1f Compare December 31, 2020 10:14

awais786 force-pushed the awais786/make-docs branch from c0e7ad5 to f4f1fc4 Compare December 31, 2020 16:00

Fixing make docs

1f616f6

Adding constraint on sphinx.

awais786 force-pushed the awais786/make-docs branch from eec5355 to 1f616f6 Compare January 5, 2021 17:42

jmbowman reviewed Jan 5, 2021

View reviewed changes

Running makeupgrade

c4ae96d

awais786 merged commit 44d97d7 into master Jan 5, 2021

awais786 deleted the awais786/make-docs branch January 5, 2021 20:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing make docs issue #25799

Fixing make docs issue #25799

awais786 commented Dec 8, 2020 •

edited

awais786 Dec 8, 2020 •

edited

jmbowman Dec 10, 2020

awais786 commented Dec 8, 2020 •

edited

jmbowman Dec 10, 2020

awais786 commented Dec 10, 2020

jmbowman commented Dec 21, 2020

awais786 Dec 29, 2020

jmbowman Jan 5, 2021

awais786 Dec 30, 2020 •

edited

awais786 commented Dec 31, 2020

awais786 commented Dec 31, 2020

awais786 commented Dec 31, 2020

awais786 commented Jan 5, 2021

jmbowman Jan 5, 2021

awais786 Jan 5, 2021

jmbowman Jan 5, 2021

jmbowman Jan 5, 2021

awais786 Jan 5, 2021 •

edited

awais786 Jan 5, 2021

edx-status-bot commented Jan 5, 2021

edx-pipeline-bot commented Jan 5, 2021

edx-pipeline-bot commented Jan 5, 2021

Fixing make docs issue #25799

Fixing make docs issue #25799

Conversation

awais786 commented Dec 8, 2020 • edited

awais786 Dec 8, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awais786 commented Dec 8, 2020 • edited

Choose a reason for hiding this comment

awais786 commented Dec 10, 2020

jmbowman commented Dec 21, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awais786 Dec 30, 2020 • edited

Choose a reason for hiding this comment

awais786 commented Dec 31, 2020

awais786 commented Dec 31, 2020

awais786 commented Dec 31, 2020

awais786 commented Jan 5, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awais786 Jan 5, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edx-status-bot commented Jan 5, 2021

edx-pipeline-bot commented Jan 5, 2021

edx-pipeline-bot commented Jan 5, 2021

awais786 commented Dec 8, 2020 •

edited

awais786 Dec 8, 2020 •

edited

awais786 commented Dec 8, 2020 •

edited

awais786 Dec 30, 2020 •

edited

awais786 Jan 5, 2021 •

edited