Skip to content

Commit

Permalink
Fixing make docs
Browse files Browse the repository at this point in the history
Adding constraint on sphinx.
  • Loading branch information
awais786 committed Dec 31, 2020
1 parent 6aa37e2 commit 9c66a1f
Show file tree
Hide file tree
Showing 11 changed files with 47 additions and 30 deletions.
2 changes: 1 addition & 1 deletion common/djangoapps/third_party_auth/provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 3 additions & 1 deletion docs/docs_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
'contentstore.apps.ContentstoreConfig',
'cms.djangoapps.course_creators',
'xblock_config.apps.XBlockConfig',
'user_tasks',
'lms.djangoapps.lti_provider'
])


COMMON_TEST_DATA_ROOT = ''
14 changes: 13 additions & 1 deletion docs/guides/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
2 changes: 1 addition & 1 deletion lms/djangoapps/commerce/api/v1/tests/test_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ def test_update(self):
self.assertIsNone(VerificationDeadline.deadline_for_course(self.course.id))

# Generate the expected data
verification_deadline = datetime(year=2020, month=12, day=31, tzinfo=pytz.utc)
verification_deadline = datetime(year=2030, month=12, day=31, tzinfo=pytz.utc)
expiration_datetime = datetime.now(pytz.utc)
response, expected = self._get_update_response_and_expected_data(expiration_datetime, verification_deadline)

Expand Down
3 changes: 3 additions & 0 deletions requirements/constraints.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.0
4 changes: 2 additions & 2 deletions requirements/edx-sandbox/py35.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ openedx-calc==1.0.9 # via -r requirements/edx-sandbox/py35.in
pycparser==2.20 # via -r requirements/edx-sandbox/shared.txt, cffi
pyparsing==2.2.0 # via -r requirements/edx-sandbox/py35.in, chem, matplotlib, openedx-calc
python-dateutil==2.4.0 # via -c requirements/edx-sandbox/../constraints.txt, matplotlib
pytz==2020.4 # via matplotlib
pytz==2020.5 # via matplotlib
random2==1.0.1 # via -r requirements/edx-sandbox/py35.in
regex==2020.11.13 # via -r requirements/edx-sandbox/shared.txt, nltk
scipy==1.2.1 # via -c requirements/edx-sandbox/../constraints.txt, -r requirements/edx-sandbox/py35.in, chem, openedx-calc
six==1.15.0 # via -r requirements/edx-sandbox/shared.txt, chem, cryptography, cycler, matplotlib, openedx-calc, python-dateutil
sympy==1.6.2 # via -c requirements/edx-sandbox/../constraints.txt, -r requirements/edx-sandbox/py35.in, symmath
tqdm==4.54.1 # via -r requirements/edx-sandbox/shared.txt, nltk
tqdm==4.55.0 # via -r requirements/edx-sandbox/shared.txt, nltk

# The following packages are considered to be unsafe in a requirements file:
# setuptools
2 changes: 1 addition & 1 deletion requirements/edx-sandbox/shared.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ nltk==3.5 # via -r requirements/edx-sandbox/shared.in
pycparser==2.20 # via cffi
regex==2020.11.13 # via nltk
six==1.15.0 # via cryptography
tqdm==4.54.1 # via nltk
tqdm==4.55.0 # via nltk
12 changes: 6 additions & 6 deletions requirements/edx/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ django-simple-history==2.12.0 # via -r requirements/edx/base.in, edx-enterprise
django-splash==0.2.9 # via -r requirements/edx/base.in
django-statici18n==2.0.1 # via -r requirements/edx/base.in
django-storages==1.8 # via -c requirements/edx/../constraints.txt, -r requirements/edx/base.in, edxval
django-user-tasks==1.3.1 # via -r requirements/edx/base.in
django-user-tasks==1.3.2 # via -r requirements/edx/base.in
django-waffle==2.0.0 # via -r requirements/edx/base.in, edx-django-utils, edx-drf-extensions, edx-enterprise, edx-proctoring, edx-toggles
django-webpack-loader==0.7.0 # via -r requirements/edx/base.in, edx-proctoring
django==2.2.17 # via -c requirements/edx/../constraints.txt, -r requirements/edx/base.in, code-annotations, django-appconf, django-classy-tags, django-config-models, django-cors-headers, django-crum, django-fernet-fields, django-filter, django-method-override, django-model-utils, django-mptt, django-multi-email-field, django-mysql, django-oauth-toolkit, django-pyfs, django-ratelimit-backend, django-sekizai, django-ses, django-splash, django-statici18n, django-storages, django-user-tasks, django-wiki, drf-jwt, drf-yasg, edx-ace, edx-api-doc-tools, edx-bulk-grades, edx-celeryutils, edx-completion, edx-django-release-util, edx-django-sites-extensions, edx-django-utils, edx-drf-extensions, edx-enterprise, edx-event-routing-backends, edx-i18n-tools, edx-milestones, edx-opaque-keys, edx-organizations, edx-proctoring, edx-rbac, edx-search, edx-submissions, edx-toggles, edx-when, edxval, enmerkar, enmerkar-underscore, event-tracking, help-tokens, jsonfield2, lti-consumer-xblock, ora2, rest-condition, super-csv, xss-utils
Expand Down Expand Up @@ -112,7 +112,7 @@ edx-search==2.0.1 # via -r requirements/edx/base.in
edx-sga==0.13.1 # via -r requirements/edx/base.in
edx-submissions==3.2.3 # via -r requirements/edx/base.in, ora2
edx-tincan-py35==0.0.9 # via edx-enterprise
edx-toggles==1.2.1 # via -c requirements/edx/../constraints.txt, -r requirements/edx/base.in, edx-completion, ora2
edx-toggles==1.2.2 # via -c requirements/edx/../constraints.txt, -r requirements/edx/base.in, edx-completion, ora2
edx-user-state-client==1.2.0 # via -r requirements/edx/base.in
edx-when==1.3.0 # via -r requirements/edx/base.in, edx-proctoring
edxval==1.4.4 # via -r requirements/edx/base.in
Expand Down Expand Up @@ -157,7 +157,7 @@ git+https://github.com/edx/MongoDBProxy.git@d92bafe9888d2940f647a7b2b2383b29c752
mongoengine==0.22.1 # via -r requirements/edx/base.in
mpmath==1.1.0 # via sympy
mysqlclient==2.0.2 # via -r requirements/edx/base.in
newrelic==5.22.1.152 # via -r requirements/edx/base.in, edx-django-utils
newrelic==5.24.0.153 # via -r requirements/edx/base.in, edx-django-utils
nltk==3.5 # via -r requirements/edx/../edx-sandbox/shared.txt, chem
nodeenv==1.5.0 # via -r requirements/edx/base.in
numpy==1.18.5 # via -c requirements/edx/../constraints.txt, chem, openedx-calc, scipy
Expand Down Expand Up @@ -192,7 +192,7 @@ python-slugify==4.0.1 # via code-annotations
python-swiftclient==3.11.0 # via ora2
python3-openid==3.2.0 ; python_version >= "3" # via -r requirements/edx/base.in, social-auth-core
python3-saml==1.9.0 # via -r requirements/edx/base.in
pytz==2020.4 # via -r requirements/edx/base.in, babel, capa, celery, django, django-ses, edx-completion, edx-enterprise, edx-event-routing-backends, edx-proctoring, edx-submissions, edx-tincan-py35, event-tracking, fs, icalendar, ora2, tincan, xblock
pytz==2020.5 # via -r requirements/edx/base.in, babel, capa, celery, django, django-ses, edx-completion, edx-enterprise, edx-event-routing-backends, edx-proctoring, edx-submissions, edx-tincan-py35, event-tracking, fs, icalendar, ora2, tincan, xblock
pyuca==1.2 # via -r requirements/edx/base.in
pyyaml==5.3.1 # via -r requirements/edx/base.in, code-annotations, edx-django-release-util, edx-i18n-tools, xblock
random2==1.0.1 # via -r requirements/edx/base.in
Expand Down Expand Up @@ -221,13 +221,13 @@ soupsieve==2.1 # via beautifulsoup4
sqlparse==0.4.1 # via -r requirements/edx/base.in, django
staff-graded-xblock==1.1 # via -r requirements/edx/base.in
stevedore==1.32.0 # via -c requirements/edx/../constraints.txt, -r requirements/edx/base.in, -r requirements/edx/paver.txt, code-annotations, edx-ace, edx-django-utils, edx-enterprise, edx-opaque-keys
super-csv==1.1.0 # via -r requirements/edx/base.in, edx-bulk-grades
super-csv==2.0.0 # via -r requirements/edx/base.in, edx-bulk-grades
sympy==1.6.2 # via -c requirements/edx/../constraints.txt, symmath
tableauserverclient==0.14.1 # via edx-enterprise
testfixtures==6.17.0 # via edx-enterprise
text-unidecode==1.3 # via python-slugify
tincan==1.0.0 # via edx-event-routing-backends
tqdm==4.54.1 # via -r requirements/edx/../edx-sandbox/shared.txt, nltk
tqdm==4.55.0 # via -r requirements/edx/../edx-sandbox/shared.txt, nltk
ua-parser==0.10.0 # via django-cookies-samesite
unicodecsv==0.14.1 # via -r requirements/edx/base.in, edx-enterprise
uritemplate==3.0.1 # via coreapi, drf-yasg
Expand Down
16 changes: 8 additions & 8 deletions requirements/edx/development.txt
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ django-simple-history==2.12.0 # via -r requirements/edx/testing.txt, edx-enterp
django-splash==0.2.9 # via -r requirements/edx/testing.txt
django-statici18n==2.0.1 # via -r requirements/edx/testing.txt
django-storages==1.8 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, edxval
django-user-tasks==1.3.1 # via -r requirements/edx/testing.txt
django-user-tasks==1.3.2 # via -r requirements/edx/testing.txt
django-waffle==2.0.0 # via -r requirements/edx/testing.txt, edx-django-utils, edx-drf-extensions, edx-enterprise, edx-proctoring, edx-toggles
django-webpack-loader==0.7.0 # via -r requirements/edx/testing.txt, edx-proctoring
django==2.2.17 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, code-annotations, django-appconf, django-classy-tags, django-config-models, django-cors-headers, django-crum, django-debug-toolbar, django-fernet-fields, django-filter, django-method-override, django-model-utils, django-mptt, django-multi-email-field, django-mysql, django-oauth-toolkit, django-pyfs, django-ratelimit-backend, django-sekizai, django-ses, django-splash, django-statici18n, django-storages, django-user-tasks, django-wiki, drf-jwt, drf-yasg, edx-ace, edx-api-doc-tools, edx-bulk-grades, edx-celeryutils, edx-completion, edx-django-release-util, edx-django-sites-extensions, edx-django-utils, edx-drf-extensions, edx-enterprise, edx-event-routing-backends, edx-i18n-tools, edx-milestones, edx-opaque-keys, edx-organizations, edx-proctoring, edx-rbac, edx-search, edx-submissions, edx-toggles, edx-when, edxval, enmerkar, enmerkar-underscore, event-tracking, help-tokens, jsonfield2, lti-consumer-xblock, ora2, rest-condition, super-csv, xss-utils
Expand Down Expand Up @@ -125,7 +125,7 @@ edx-sga==0.13.1 # via -r requirements/edx/testing.txt
edx-sphinx-theme==1.6.0 # via -r requirements/edx/development.in
edx-submissions==3.2.3 # via -r requirements/edx/testing.txt, ora2
edx-tincan-py35==0.0.9 # via -r requirements/edx/testing.txt, edx-enterprise
edx-toggles==1.2.1 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, edx-completion, ora2
edx-toggles==1.2.2 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, edx-completion, ora2
edx-user-state-client==1.2.0 # via -r requirements/edx/testing.txt
edx-when==1.3.0 # via -r requirements/edx/testing.txt, edx-proctoring
edxval==1.4.4 # via -r requirements/edx/testing.txt
Expand All @@ -135,7 +135,7 @@ enmerkar==0.7.1 # via -r requirements/edx/testing.txt, enmerkar-unders
event-tracking==1.0.3 # via -r requirements/edx/testing.txt, edx-event-routing-backends, edx-proctoring, edx-search
execnet==1.7.1 # via -r requirements/edx/testing.txt, pytest-xdist
factory-boy==2.8.1 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt
faker==5.0.2 # via -r requirements/edx/testing.txt, factory-boy
faker==5.3.0 # via -r requirements/edx/testing.txt, factory-boy
filelock==3.0.12 # via -r requirements/edx/testing.txt, tox, virtualenv
freezegun==0.3.12 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt
fs-s3fs==0.1.8 # via -r requirements/edx/testing.txt, django-pyfs
Expand Down Expand Up @@ -190,7 +190,7 @@ mongoengine==0.22.1 # via -r requirements/edx/testing.txt
more-itertools==8.6.0 # via -r requirements/edx/testing.txt, zipp
mpmath==1.1.0 # via -r requirements/edx/testing.txt, sympy
mysqlclient==2.0.2 # via -r requirements/edx/testing.txt
newrelic==5.22.1.152 # via -r requirements/edx/testing.txt, edx-django-utils
newrelic==5.24.0.153 # via -r requirements/edx/testing.txt, edx-django-utils
nltk==3.5 # via -r requirements/edx/testing.txt, chem
nodeenv==1.5.0 # via -r requirements/edx/testing.txt
numpy==1.18.5 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, chem, openedx-calc, scipy
Expand Down Expand Up @@ -244,7 +244,7 @@ python-slugify==4.0.1 # via -r requirements/edx/testing.txt, code-annotation
python-swiftclient==3.11.0 # via -r requirements/edx/testing.txt, ora2
python3-openid==3.2.0 ; python_version >= "3" # via -r requirements/edx/testing.txt, social-auth-core
python3-saml==1.9.0 # via -r requirements/edx/testing.txt
pytz==2020.4 # via -r requirements/edx/testing.txt, babel, capa, celery, django, django-ses, edx-completion, edx-enterprise, edx-event-routing-backends, edx-proctoring, edx-submissions, edx-tincan-py35, event-tracking, fs, icalendar, ora2, tincan, xblock
pytz==2020.5 # via -r requirements/edx/testing.txt, babel, capa, celery, django, django-ses, edx-completion, edx-enterprise, edx-event-routing-backends, edx-proctoring, edx-submissions, edx-tincan-py35, event-tracking, fs, icalendar, ora2, tincan, xblock
pyuca==1.2 # via -r requirements/edx/testing.txt
pywatchman==1.4.1 # via -r requirements/edx/development.in
pyyaml==5.3.1 # via -r requirements/edx/testing.txt, code-annotations, edx-django-release-util, edx-i18n-tools, sphinxcontrib-openapi, xblock
Expand Down Expand Up @@ -275,7 +275,7 @@ social-auth-core==3.3.3 # via -r requirements/edx/testing.txt, social-auth-app
sorl-thumbnail==12.7.0 # via -r requirements/edx/testing.txt, django-wiki
sortedcontainers==2.3.0 # via -r requirements/edx/testing.txt
soupsieve==2.1 # via -r requirements/edx/testing.txt, beautifulsoup4
sphinx==3.4.0 # via edx-sphinx-theme, sphinxcontrib-httpdomain
sphinx==3.3.0 # via -c requirements/edx/../constraints.txt, edx-sphinx-theme, sphinxcontrib-httpdomain
sphinxcontrib-applehelp==1.0.2 # via sphinx
sphinxcontrib-devhelp==1.0.2 # via sphinx
sphinxcontrib-htmlhelp==1.0.3 # via sphinx
Expand All @@ -287,7 +287,7 @@ sphinxcontrib-serializinghtml==1.1.4 # via sphinx
sqlparse==0.4.1 # via -r requirements/edx/testing.txt, django, django-debug-toolbar
staff-graded-xblock==1.1 # via -r requirements/edx/testing.txt
stevedore==1.32.0 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, code-annotations, edx-ace, edx-django-utils, edx-enterprise, edx-opaque-keys
super-csv==1.1.0 # via -r requirements/edx/testing.txt, edx-bulk-grades
super-csv==2.0.0 # via -r requirements/edx/testing.txt, edx-bulk-grades
sympy==1.6.2 # via -c requirements/edx/../constraints.txt, -r requirements/edx/testing.txt, symmath
tableauserverclient==0.14.1 # via -r requirements/edx/testing.txt, edx-enterprise
testfixtures==6.17.0 # via -r requirements/edx/testing.txt, edx-enterprise
Expand All @@ -296,7 +296,7 @@ tincan==1.0.0 # via -r requirements/edx/testing.txt, edx-event-routi
toml==0.10.2 # via -r requirements/edx/testing.txt, pylint, pytest, tox
tox-battery==0.6.1 # via -r requirements/edx/testing.txt
tox==3.20.1 # via -r requirements/edx/testing.txt, tox-battery
tqdm==4.54.1 # via -r requirements/edx/testing.txt, nltk
tqdm==4.55.0 # via -r requirements/edx/testing.txt, nltk
transifex-client==0.14.2 # via -r requirements/edx/testing.txt
ua-parser==0.10.0 # via -r requirements/edx/testing.txt, django-cookies-samesite
unicodecsv==0.14.1 # via -r requirements/edx/testing.txt, edx-enterprise
Expand Down
4 changes: 2 additions & 2 deletions requirements/edx/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ pbr==5.5.1 # via stevedore
pygments==2.7.3 # via sphinx
pyparsing==2.4.7 # via packaging
python-slugify==4.0.1 # via code-annotations
pytz==2020.4 # via babel, django
pytz==2020.5 # via babel, django
pyyaml==5.3.1 # via code-annotations
requests==2.25.1 # via sphinx
six==1.15.0 # via edx-sphinx-theme, stevedore
smmap==3.0.4 # via gitdb
snowballstemmer==2.0.0 # via sphinx
sphinx==3.4.0 # via -r requirements/edx/doc.in, edx-sphinx-theme
sphinx==3.3.0 # via -c requirements/edx/../constraints.txt, -r requirements/edx/doc.in, edx-sphinx-theme
sphinxcontrib-applehelp==1.0.2 # via sphinx
sphinxcontrib-devhelp==1.0.2 # via sphinx
sphinxcontrib-htmlhelp==1.0.3 # via sphinx
Expand Down
Loading

0 comments on commit 9c66a1f

Please sign in to comment.