Commit df13b521 by Peter Desjardins

Fix doc build failures that were caused by Python module import failures. Also…

Fix doc build failures that were caused by Python module import failures. Also fix broken cross references. https://openedx.atlassian.net/browse/DOC-2478
parent c14c146d
path.py path.py
Django >=1.4,<1.5 Django >=1.8,<1.9
django-simple-history==1.6.3
pytz pytz
-e git+https://github.com/edx/XBlock.git#egg=XBlock git+https://github.com/edx/XBlock.git#egg=XBlock
git+https://github.com/edx/django-rest-framework-oauth.git@f0b503fda8c254a38f97fef802ded4f5fe367f7a#egg=djangorestframework_oauth-master
lxml lxml
Babel
lazy
sphinxcontrib-napoleon==0.2.6 sphinxcontrib-napoleon==0.2.6
sphinx_rtd_theme
stevedore==0.14.1 stevedore==0.14.1
djangorestframework==2.3.14 djangorestframework==3.2.3
PyYAML>=3.10 PyYAML>=3.10
mock
...@@ -15,7 +15,7 @@ Change Log ...@@ -15,7 +15,7 @@ Change Log
* - 10 June 2015 * - 10 June 2015
- Added the section :ref:`Profile Images API Version 1.0`. - Added the section :ref:`Profile Images API Version 1.0`.
* - 11 May 2015 * - 11 May 2015
- Updated the :ref:`User API <edX Platform User API Version 1.0>` to - Updated the :ref:`User API <edX Platform User API>` to
Version 1.0. Version 1.0.
* - * -
- Added the :ref:`User Preferences API`. - Added the :ref:`User Preferences API`.
...@@ -26,7 +26,6 @@ Change Log ...@@ -26,7 +26,6 @@ Change Log
``enrollment_start`` and ``enrollment_end fields``. ``enrollment_start`` and ``enrollment_end fields``.
* - 2 April 2015 * - 2 April 2015
- Added the :ref:`EdX Platform Course Structure API Version 0`, :ref:`edX - Added the :ref:`EdX Platform Course Structure API Version 0`, :ref:`edX
Platform Enrollment API Version 1.0` and edX Platform User API Platform Enrollment API` and edX Platform User API Version 0 sections.
Version 0 sections.
* - 29 January 2015 * - 29 January 2015
- Added the :ref:`Get or Change User Status in a Course` section. - Added the :ref:`Get or Change User Status in a Course` section.
...@@ -13,55 +13,35 @@ MOCK_MODULES = [ ...@@ -13,55 +13,35 @@ MOCK_MODULES = [
'lxml', 'lxml',
'requests', 'requests',
'xblock', 'xblock',
'fields',
'xblock.fields', 'xblock.fields',
'frament',
'xblock.fragment', 'xblock.fragment',
'webob', 'webob',
'multidict',
'webob.multidict', 'webob.multidict',
'core',
'xblock.core', 'xblock.core',
'runtime',
'xblock.runtime', 'xblock.runtime',
'sortedcontainers', 'sortedcontainers',
'contracts', 'contracts',
'plugin',
'xblock.plugin', 'xblock.plugin',
'opaque_keys.edx.asides', 'opaque_keys.edx.asides',
'asides',
'dogstats_wrapper', 'dogstats_wrapper',
'fs', 'fs',
'fs.errors', 'fs.errors',
'edxmako', 'edxmako',
'edxmako.shortcuts', 'edxmako.shortcuts',
'shortcuts',
'crum', 'crum',
'opaque_keys.edx.locator', 'opaque_keys.edx.locator',
'LibraryLocator',
'Location',
'ipware', 'ipware',
'ip',
'ipware.ip', 'ipware.ip',
'get_ip',
'pygeoip', 'pygeoip',
'ipaddr', 'ipaddr',
'django_countries', 'django_countries',
'fields',
'django_countries.fields', 'django_countries.fields',
'opaque_keys', 'opaque_keys',
'opaque_keys.edx', 'opaque_keys.edx',
'opaque_keys.edx.keys', 'opaque_keys.edx.keys',
'CourseKey',
'UsageKey',
'BlockTypeKey',
'opaque_keys.edx.locations', 'opaque_keys.edx.locations',
'SlashSeparatedCourseKey',
'Locator',
'courseware', 'courseware',
'access',
'courseware.access', 'courseware.access',
'is_mobile_available_for_user',
'courseware.model_data', 'courseware.model_data',
'courseware.module_render', 'courseware.module_render',
'courseware.views', 'courseware.views',
...@@ -81,9 +61,7 @@ MOCK_MODULES = [ ...@@ -81,9 +61,7 @@ MOCK_MODULES = [
'analytics', 'analytics',
'courseware.courses', 'courseware.courses',
'django.contrib.staticfiles', 'django.contrib.staticfiles',
'storage',
'django.contrib.staticfiles.storage', 'django.contrib.staticfiles.storage',
'content',
'xmodule.contentstore', 'xmodule.contentstore',
'xmodule.contentstore.content', 'xmodule.contentstore.content',
'xblock.exceptions', 'xblock.exceptions',
...@@ -98,18 +76,13 @@ MOCK_MODULES = [ ...@@ -98,18 +76,13 @@ MOCK_MODULES = [
'social.apps.django_app', 'social.apps.django_app',
'social.backends', 'social.backends',
'mako', 'mako',
'exceptions',
'mako.exceptions', 'mako.exceptions',
'boto', 'boto',
'exception',
'boto.exception', 'boto.exception',
'PIL', 'PIL',
'reportlab', 'reportlab',
'lib',
'reportlab.lib', 'reportlab.lib',
'pdfgen', 'pdfgen',
'canvas',
'pdfgen',
'pdfgen.canvas', 'pdfgen.canvas',
'reportlab.pdfgen', 'reportlab.pdfgen',
'reportlab.pdfgen.canvas', 'reportlab.pdfgen.canvas',
...@@ -118,9 +91,6 @@ MOCK_MODULES = [ ...@@ -118,9 +91,6 @@ MOCK_MODULES = [
'reportlab.lib.styles', 'reportlab.lib.styles',
'reportlab.platypus', 'reportlab.platypus',
'reportlab.platypus.tables', 'reportlab.platypus.tables',
'boto',
's3',
'connection',
'boto.s3', 'boto.s3',
'boto.s3.connection', 'boto.s3.connection',
'boto.s3.key', 'boto.s3.key',
...@@ -128,13 +98,9 @@ MOCK_MODULES = [ ...@@ -128,13 +98,9 @@ MOCK_MODULES = [
'Crypto.Cipher', 'Crypto.Cipher',
'Crypto.PublicKey', 'Crypto.PublicKey',
'openid', 'openid',
'store',
'interface',
'openid.store', 'openid.store',
'store.interface',
'openid.store.interface', 'openid.store.interface',
'external_auth.views', 'external_auth.views',
'html_to_text',
'mail_utils', 'mail_utils',
'ratelimitbackend.backends', 'ratelimitbackend.backends',
'social.apps.django_app.default', 'social.apps.django_app.default',
...@@ -166,35 +132,23 @@ MOCK_MODULES = [ ...@@ -166,35 +132,23 @@ MOCK_MODULES = [
'student.roles', 'student.roles',
'embargo.models', 'embargo.models',
'xmodule.vertical_block', 'xmodule.vertical_block',
'vertical_block',
'errors',
'UserNotFound',
'UserNotAuthorized',
'AccountUpdateError',
'AccountValidationError',
'transaction',
'parsers',
'MergePatchParser',
'get_account_settings',
'update_account_settings',
'serializers',
'profile_images.images',
'xmodule.course_module', 'xmodule.course_module',
'user_api.accounts.api', 'user_api.accounts.api',
'user_api.accounts.serializers', 'user_api.accounts.serializers',
'edx_rest_api_client', 'edx_rest_api_client',
'client',
'edx_rest_api_client.client', 'edx_rest_api_client.client',
'edx_rest_api_client.exceptions', 'edx_rest_api_client.exceptions',
'student.auth', 'student.auth',
'ccx_keys', 'ccx_keys',
'ccx_keys.locator', 'ccx_keys.locator',
'user_api.preferences.api', 'user_api.preferences.api',
'rest_framework_oauth.authentication' 'rest_framework_oauth.authentication',
'certificates.api',
'courseware.date_summary',
] ]
for mod_name in MOCK_MODULES: for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.Mock(class_that_is_extended=object) sys.modules[mod_name] = mock.Mock()
if "DJANGO_SETTINGS_MODULE" not in os.environ: if "DJANGO_SETTINGS_MODULE" not in os.environ:
docs_path = os.getcwd() docs_path = os.getcwd()
......
...@@ -6,3 +6,7 @@ This is the local_settings file for platform API doc. ...@@ -6,3 +6,7 @@ This is the local_settings file for platform API doc.
from random import choice from random import choice
characters = 'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)' characters = 'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'
SECRET_KEY = ''.join([choice(characters) for i in range(50)]) SECRET_KEY = ''.join([choice(characters) for i in range(50)])
# for use in openedx/core/djangoapps/profile_images/images.py
PROFILE_IMAGE_MAX_BYTES = 1000
PROFILE_IMAGE_MIN_BYTES = 1000
...@@ -14,17 +14,17 @@ interchange format. The APIs also use edX OAuth 2.0 for :ref:`authentication ...@@ -14,17 +14,17 @@ interchange format. The APIs also use edX OAuth 2.0 for :ref:`authentication
Supported edX Platform API Modules Supported edX Platform API Modules
********************************************** **********************************************
The following edX Platform APIs are currently supported: The following edX Platform APIs are currently supported.
* :ref:`edX Platform Enrollment API Version 1.0` * :ref:`edX Platform Enrollment API`
* :ref:`edX Platform Mobile API Version 0.5` * :ref:`edX Platform Mobile API Version 0.5`
* :ref:`Profile Images API Version 1.0` * :ref:`Profile Images API Version 1.0`
* :ref:`edX Platform User API Version 1.0` * :ref:`edX Platform User API`
********************************************** **********************************************
Experimental edX Platform API Modules Experimental edX Platform API Modules
********************************************** **********************************************
The following edX Platform APIs are currently experimental: The following edX Platform APIs are currently experimental.
* :ref:`EdX Platform Course Structure API Version 0` * :ref:`EdX Platform Course Structure API Version 0`
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment