Skip to content

Commit db8b0ff

Browse files
authored
Use syntax highlighting in readme (#1102)
1 parent 9ced3be commit db8b0ff

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ Overview
2424
* Format specification: https://jsonapi.org/format/
2525

2626

27-
By default, Django REST framework will produce a response like::
27+
By default, Django REST framework will produce a response like:
28+
29+
.. code:: JSON
2830
2931
{
3032
"count": 20,
@@ -39,7 +41,9 @@ By default, Django REST framework will produce a response like::
3941
4042
4143
However, for an ``identity`` model in JSON:API format the response should look
42-
like the following::
44+
like the following:
45+
46+
.. code:: JSON
4347
4448
{
4549
"links": {
@@ -104,7 +108,7 @@ Installation
104108

105109
Install using ``pip``...
106110

107-
::
111+
.. code:: sh
108112
109113
$ pip install djangorestframework-jsonapi
110114
$ # for optional package integrations
@@ -115,7 +119,7 @@ Install using ``pip``...
115119
116120
or from source...
117121

118-
::
122+
.. code:: sh
119123
120124
$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git
121125
$ cd django-rest-framework-json-api
@@ -124,7 +128,7 @@ or from source...
124128
125129
and add ``rest_framework_json_api`` to your ``INSTALLED_APPS`` setting below ``rest_framework``.
126130

127-
::
131+
.. code:: python
128132
129133
INSTALLED_APPS = [
130134
...
@@ -140,7 +144,7 @@ Running the example app
140144
It is recommended to create a virtualenv for testing. Assuming it is already
141145
installed and activated:
142146

143-
::
147+
.. code:: sh
144148
145149
$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git
146150
$ cd django-rest-framework-json-api
@@ -172,7 +176,7 @@ One can either add ``rest_framework_json_api.parsers.JSONParser`` and
172176
``rest_framework_json_api.renderers.JSONRenderer`` to each ``ViewSet`` class, or
173177
override ``settings.REST_FRAMEWORK``
174178

175-
::
179+
.. code:: python
176180
177181
REST_FRAMEWORK = {
178182
'PAGE_SIZE': 10,

0 commit comments

Comments
 (0)