Skip to content

E
edx-platform
Commit 35521a38 by Peter Desjardins
Options

Fixed import failures that were preventing the platform API documentation from… 

Fixed import failures that were preventing the platform API documentation from building. The problem is that the doc building environment doesn't need to install all the Python modules that the platform software does, but when Sphinx tries to import select modules so that it can use autoclass to publish docstrings it tries to import all the modules that are imported by those modules, recursively. I mocked the missing modules.
parent 2e2a23b9
Showing with 70 additions and 66 deletions
docs/en_us/platform_api/source/conf.py
......@@ -157,6 +157,11 @@ MOCK_MODULES = [
'celery.signals',
'edx_rest_framework_extensions',
'edx_rest_framework_extensions.authentication',
'django_extensions',
'django_extensions.db',
'django_extensions.db.models',
'jsonfield',
'jsonfield.fields',
]
for mod_name in MOCK_MODULES:
......
docs/en_us/platform_api/source/enrollment/enrollment.rst
###################################
Enrollment API Enrollment Resource
Enrollment API Enrollment Resource
###################################
With the Enrollment API **Enrollment** resource, you can complete the
......@@ -8,7 +8,7 @@ following tasks.
.. contents::
:local:
:depth: 1
.. _Get the Users Enrollment Status in a Course:
......@@ -20,7 +20,7 @@ Get the User's Enrollment Status in a Course
**Example response showing the user's enrollment status in a course**
.. code-block:: json
.. code-block:: none
HTTP 200 OK
Content-Type: application/json
......@@ -28,26 +28,26 @@ Get the User's Enrollment Status in a Course
Allow: GET, HEAD, OPTIONS
{
"created": "2014-11-19T04:06:55Z",
"mode": "honor",
"is_active": true,
"created": "2014-11-19T04:06:55Z",
"mode": "honor",
"is_active": true,
"course_details": {
"course_id": "edX/DemoX/Demo_Course",
"enrollment_end": null,
"course_id": "edX/DemoX/Demo_Course",
"enrollment_end": null,
"course_modes": [
{
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"description": null
}
],
"enrollment_start": null,
],
"enrollment_start": null,
"invite_only": false
},
},
"user": "staff"
}
......@@ -61,7 +61,7 @@ Get the User's Enrollment Information for a Course
**Example response showing a user's course enrollment information**
.. code-block:: json
.. code-block:: none
HTTP 200 OK
Content-Type: application/json
......@@ -69,20 +69,20 @@ Get the User's Enrollment Information for a Course
Allow: GET, HEAD, OPTIONS
{
"course_id": "edX/DemoX/Demo_Course",
"enrollment_end": null,
"course_id": "edX/DemoX/Demo_Course",
"enrollment_end": null,
"course_modes": [
{
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"description": null
}
],
"enrollment_start": null,
],
"enrollment_start": null,
"invite_only": false
}
......@@ -98,7 +98,7 @@ View a User's Enrollments or Enroll a User in a Course
**Example response showing a user who is enrolled in two courses**
.. code-block:: json
.. code-block:: none
HTTP 200 OK
Content-Type: application/json
......@@ -107,49 +107,49 @@ View a User's Enrollments or Enroll a User in a Course
[
{
"created": "2014-09-19T18:08:37Z",
"mode": "honor",
"is_active": true,
"created": "2014-09-19T18:08:37Z",
"mode": "honor",
"is_active": true,
"course_details": {
"course_id": "edX/DemoX/Demo_Course",
"enrollment_end": null,
"course_id": "edX/DemoX/Demo_Course",
"enrollment_end": null,
"course_modes": [
{
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"description": null
}
],
"enrollment_start": null,
],
"enrollment_start": null,
"invite_only": false
},
},
"user": "honor"
},
},
{
"created": "2014-09-19T18:09:35Z",
"mode": "honor",
"is_active": true,
"created": "2014-09-19T18:09:35Z",
"mode": "honor",
"is_active": true,
"course_details": {
"course_id": "ArbisoftX/BulkyEmail101/2014-15",
"enrollment_end": null,
"course_id": "ArbisoftX/BulkyEmail101/2014-15",
"enrollment_end": null,
"course_modes": [
{
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"slug": "honor",
"name": "Honor Code Certificate",
"min_price": 0,
"suggested_prices": [],
"currency": "usd",
"expiration_datetime": null,
"description": null
}
],
"enrollment_start": "2014-05-01T04:00:00Z",
],
"enrollment_start": "2014-05-01T04:00:00Z",
"invite_only": false
},
},
"user": "honor"
}
]
......@@ -163,4 +163,4 @@ View a User's Enrollments or Enroll a User in a Course
"course_details": {
"course_id": "edX/DemoX/Demo_Course"
}
}
\ No newline at end of file
}
docs/en_us/platform_api/source/user/accounts.rst
......@@ -21,7 +21,7 @@ Get and Update a User's Account Information
**Example response showing a user's account information**
.. code-block:: json
.. code-block:: none
HTTP 200 OK
Content-Type: application/json
......
docs/en_us/platform_api/source/user/preferences.rst
......@@ -21,7 +21,7 @@ Get and Update the User's Preferences Information
**Example response showing the user's preference information**
.. code-block:: json
.. code-block:: none
HTTP 200 OK
Content-Type: application/json
......@@ -29,9 +29,9 @@ Get and Update the User's Preferences Information
Allow: GET, HEAD, OPTIONS, PATCH
{
"pref-lang": "en",
"account_privacy": "private"
}
"pref-lang": "en",
"account_privacy": "private"
}
.. _Get Update or Delete a Specific Preference:
......@@ -43,7 +43,7 @@ Get, Update, or Delete a Specific Preference
**Example response to a request for the user's account_privacy setting**
.. code-block:: json
.. code-block:: none
HTTP 200 OK
Content-Type: application/json
......
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