Skip to content

Commit b8d98bf

Browse files
committed
[docs] Minor docs fixes
1 parent 59a5ac4 commit b8d98bf

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/developer/admin-utils.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ creating filters for related multitenant models.
6565

6666
Consider the following example from `IpAddressAdmin in openwisp-ipam
6767
<https://github.com/openwisp/openwisp-ipam/blob/956d9d25fc1ac339cb148ec7faf80046cc14be37/openwisp_ipam/admin.py#L216-L227>`_.
68-
``IpAddressAdmin`` allows filtering `IpAddress objects by ``Subnet``
68+
``IpAddressAdmin`` allows filtering ``IpAddress`` objects by ``Subnet``
6969
belonging to organizations managed by the user.
7070

7171
.. code-block:: python

docs/developer/extending.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ A Django app is nothing more than a `Python package
4444
of Python scripts). In the following examples, we'll call this Django app
4545
``myusers``, but you can name it however you like:
4646

47-
.. code-block::
47+
.. code-block:: bash
4848
4949
django-admin startapp myusers
5050
@@ -73,7 +73,7 @@ apps, please refer to the `Django documentation
7373

7474
Install (and add to the requirements of your project) openwisp-users:
7575

76-
.. code-block::
76+
.. code-block:: bash
7777
7878
pip install openwisp-users
7979
@@ -185,7 +185,7 @@ Substitute ``myusers`` with the name you chose in step 1.
185185

186186
Create database migrations:
187187

188-
.. code-block::
188+
.. code-block:: bash
189189
190190
./manage.py makemigrations
191191
@@ -196,7 +196,7 @@ contents of the `sample_users/migrations/0004_default_groups.py
196196

197197
Then, run the migrations:
198198

199-
.. code-block::
199+
.. code-block:: bash
200200
201201
./manage.py migrate
202202
@@ -361,7 +361,7 @@ to find out how to do this.
361361

362362
You can then run tests with:
363363

364-
.. code-block::
364+
.. code-block:: bash
365365
366366
# the --parallel flag is optional
367367
./manage.py test --parallel myusers

docs/developer/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Developer Docs
88

99
./installation.rst
1010
./admin-utils.rst
11-
./django-rest-framework-utils
11+
./django-rest-framework-utils.rst
1212
./misc-utils.rst
1313
./extending.rst
1414

docs/developer/misc-utils.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The cache is automatically invalidated on the following events:
9696

9797
Usage example:
9898

99-
.. code-block::
99+
.. code-block:: python
100100
101101
>>> user.organizations_dict
102102
... {'20135c30-d486-4d68-993f-322b8acb51c4': {'is_admin': True, 'is_owner': False}}
@@ -110,7 +110,7 @@ Returns a list of primary keys of organizations the user can manage.
110110

111111
Usage example:
112112

113-
.. code-block::
113+
.. code-block:: python
114114
115115
>>> user.organizations_managed
116116
... ['20135c30-d486-4d68-993f-322b8acb51c4']
@@ -122,7 +122,7 @@ Returns a list of primary keys of organizations the user owns.
122122

123123
Usage example:
124124

125-
.. code-block::
125+
.. code-block:: python
126126
127127
>>> user.organizations_owned
128128
... ['20135c30-d486-4d68-993f-322b8acb51c4']

0 commit comments

Comments
 (0)