Skip to content
This repository was archived by the owner on May 1, 2024. It is now read-only.

Commit 1543d0a

Browse files
feanilfeanil
committed
docs: Fix parse errors in code blocks.
Lots of code blocks claimed to be json but were not infact valid JSON documents. They were sample HTTP responses. Not setting a default language seems to produce output that still highlights json and doesn't throw errors so falling back to that instead of the explicit decleration of JSON.
1 parent b2d1a21 commit 1543d0a

3 files changed

Lines changed: 75 additions & 75 deletions

File tree

‎docs/api/source/courses.rst‎

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
Course Information API
33
#######################
44

5-
.. contents:: Section Contents
5+
.. contents:: Section Contents
66
:local:
77
:depth: 1
8-
8+
99
.. _Get Weekly Course Activity:
1010

1111
***************************
@@ -16,12 +16,12 @@ Get Weekly Course Activity
1616

1717
**Example Response**
1818

19-
.. code-block:: json
19+
.. code-block::
2020
21-
HTTP 200 OK
22-
Vary: Accept
23-
Content-Type: text/html; charset=utf-8
24-
Allow: GET, HEAD, OPTIONS
21+
HTTP 200 OK
22+
Vary: Accept
23+
Content-Type: text/html; charset=utf-8
24+
Allow: GET, HEAD, OPTIONS
2525
2626
[
2727
{
@@ -45,12 +45,12 @@ Get Recent Course Activity
4545

4646
**Example Response**
4747

48-
.. code-block:: json
48+
.. code-block::
4949
50-
HTTP 200 OK
51-
Vary: Accept
52-
Content-Type: text/html; charset=utf-8
53-
Allow: GET, HEAD, OPTIONS
50+
HTTP 200 OK
51+
Vary: Accept
52+
Content-Type: text/html; charset=utf-8
53+
Allow: GET, HEAD, OPTIONS
5454
5555
{
5656
"interval_start": "2014-12-08T00:00:00Z",
@@ -70,12 +70,12 @@ Get the Course Enrollment
7070

7171
**Example Response**
7272

73-
.. code-block:: json
73+
.. code-block::
7474
75-
HTTP 200 OK
76-
Vary: Accept
77-
Content-Type: text/html; charset=utf-8
78-
Allow: GET, HEAD, OPTIONS
75+
HTTP 200 OK
76+
Vary: Accept
77+
Content-Type: text/html; charset=utf-8
78+
Allow: GET, HEAD, OPTIONS
7979
[
8080
{
8181
"course_id": "edX/DemoX/Demo_Course",
@@ -95,12 +95,12 @@ Get the Course Enrollment by Mode
9595

9696
**Example Response**
9797

98-
.. code-block:: json
98+
.. code-block::
9999
100-
HTTP 200 OK
101-
Vary: Accept
102-
Content-Type: text/html; charset=utf-8
103-
Allow: GET, HEAD, OPTIONS
100+
HTTP 200 OK
101+
Vary: Accept
102+
Content-Type: text/html; charset=utf-8
103+
Allow: GET, HEAD, OPTIONS
104104
105105
[
106106
{
@@ -125,12 +125,12 @@ Get the Course Enrollment by Birth Year
125125

126126
**Example Response**
127127

128-
.. code-block:: json
128+
.. code-block::
129129
130-
HTTP 200 OK
131-
Vary: Accept
132-
Content-Type: text/html; charset=utf-8
133-
Allow: GET, HEAD, OPTIONS
130+
HTTP 200 OK
131+
Vary: Accept
132+
Content-Type: text/html; charset=utf-8
133+
Allow: GET, HEAD, OPTIONS
134134
135135
[
136136
{
@@ -159,12 +159,12 @@ Get the Course Enrollment by Education Level
159159

160160
**Example Response**
161161

162-
.. code-block:: json
162+
.. code-block::
163163
164-
HTTP 200 OK
165-
Vary: Accept
166-
Content-Type: text/html; charset=utf-8
167-
Allow: GET, HEAD, OPTIONS
164+
HTTP 200 OK
165+
Vary: Accept
166+
Content-Type: text/html; charset=utf-8
167+
Allow: GET, HEAD, OPTIONS
168168
169169
[
170170
{
@@ -193,12 +193,12 @@ Get the Course Enrollment by Gender
193193

194194
**Example Response**
195195

196-
.. code-block:: json
196+
.. code-block::
197197
198-
HTTP 200 OK
199-
Vary: Accept
200-
Content-Type: text/html; charset=utf-8
201-
Allow: GET, HEAD, OPTIONS
198+
HTTP 200 OK
199+
Vary: Accept
200+
Content-Type: text/html; charset=utf-8
201+
Allow: GET, HEAD, OPTIONS
202202
203203
[
204204
{
@@ -224,12 +224,12 @@ See `ISO 3166 country codes`_ for more information.
224224

225225
**Example Response**
226226

227-
.. code-block:: json
227+
.. code-block::
228228
229-
HTTP 200 OK
230-
Vary: Accept
231-
Content-Type: text/html; charset=utf-8
232-
Allow: GET, HEAD, OPTIONS
229+
HTTP 200 OK
230+
Vary: Accept
231+
Content-Type: text/html; charset=utf-8
232+
Allow: GET, HEAD, OPTIONS
233233
234234
[
235235
{
@@ -266,12 +266,12 @@ Get the Course Video Data
266266

267267
**Example Response**
268268

269-
.. code-block:: json
269+
.. code-block::
270270
271-
HTTP 200 OK
272-
Vary: Accept
273-
Content-Type: text/html; charset=utf-8
274-
Allow: GET, HEAD, OPTIONS
271+
HTTP 200 OK
272+
Vary: Accept
273+
Content-Type: text/html; charset=utf-8
274+
Allow: GET, HEAD, OPTIONS
275275
276276
[
277277
{
@@ -295,7 +295,7 @@ Get the Course Video Data
295295
"users_at_start": 1044,
296296
"users_at_end": 0,
297297
"created": "2015-04-15T214158"
298-
},
298+
},
299299
]
300300
301301
.. include:: links.rst

‎docs/api/source/problems.rst‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22
Problem Information API
33
########################
44

5-
.. contents:: Section Contents
5+
.. contents:: Section Contents
66
:local:
77
:depth: 1
8-
8+
99
.. _Get the Grade Distribution for a Course:
1010

1111
***************************************
1212
Get the Grade Distribution for a Course
1313
***************************************
1414

15-
.. autoclass:: analytics_data_api.v0.views.problems.GradeDistributionView
15+
.. autoclass:: analytics_data_api.v0.views.problems.GradeDistributionView
1616

1717
**Example Response**
1818

19-
.. code-block:: json
19+
.. code-block::
2020
21-
HTTP 200 OK
22-
Vary: Accept
23-
Content-Type: text/html; charset=utf-8
24-
Allow: GET, HEAD, OPTIONS
21+
HTTP 200 OK
22+
Vary: Accept
23+
Content-Type: text/html; charset=utf-8
24+
Allow: GET, HEAD, OPTIONS
2525
2626
[
2727
{
@@ -52,12 +52,12 @@ Get the Answer Distribution for a Problem
5252

5353
**Example Response**
5454

55-
.. code-block:: json
55+
.. code-block::
5656
57-
HTTP 200 OK
58-
Vary: Accept
59-
Content-Type: text/html; charset=utf-8
60-
Allow: GET, HEAD, OPTIONS
57+
HTTP 200 OK
58+
Vary: Accept
59+
Content-Type: text/html; charset=utf-8
60+
Allow: GET, HEAD, OPTIONS
6161
6262
[
6363
{
@@ -72,7 +72,7 @@ Get the Answer Distribution for a Problem
7272
"answer_value_text": "Russia",
7373
"answer_value_numeric": null,
7474
"problem_display_name": "Multiple Choice Problem",
75-
"question_text": "Which of the following countries has the largest
75+
"question_text": "Which of the following countries has the largest
7676
population?",
7777
"variant": null,
7878
"created": "2014-12-05T225026"
@@ -89,7 +89,7 @@ Get the Answer Distribution for a Problem
8989
"answer_value_text": "Indonesia",
9090
"answer_value_numeric": null,
9191
"problem_display_name": "Multiple Choice Problem",
92-
"question_text": "Which of the following countries has the largest
92+
"question_text": "Which of the following countries has the largest
9393
population?",
9494
"variant": null,
9595
"created": "2014-12-05T225026"
@@ -106,12 +106,12 @@ Get the View Count for a Subsection
106106

107107
**Example Response**
108108

109-
.. code-block:: json
109+
.. code-block::
110110
111-
HTTP 200 OK
112-
Vary: Accept
113-
Content-Type: text/html; charset=utf-8
114-
Allow: GET, HEAD, OPTIONS
111+
HTTP 200 OK
112+
Vary: Accept
113+
Content-Type: text/html; charset=utf-8
114+
Allow: GET, HEAD, OPTIONS
115115
116116
[
117117
{

‎docs/api/source/videos.rst‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Video Data API
55
###############
66

7-
.. contents:: Section Contents
7+
.. contents:: Section Contents
88
:local:
99
:depth: 1
1010

@@ -14,16 +14,16 @@ Video Data API
1414
Get the Timeline for a Video
1515
***************************************
1616

17-
.. autoclass:: analytics_data_api.v0.views.videos.VideoTimelineView
17+
.. autoclass:: analytics_data_api.v0.views.videos.VideoTimelineView
1818

1919
**Example Response**
2020

21-
.. code-block:: json
21+
.. code-block::
2222
23-
HTTP 200 OK
24-
Vary: Accept
25-
Content-Type: text/html; charset=utf-8
26-
Allow: GET, HEAD, OPTIONS
23+
HTTP 200 OK
24+
Vary: Accept
25+
Content-Type: text/html; charset=utf-8
26+
Allow: GET, HEAD, OPTIONS
2727
2828
[
2929
{

0 commit comments

Comments
 (0)