Skip to content

Commit a44631b

Browse files
committed
docs updated
1 parent 2e1eaf9 commit a44631b

3 files changed

Lines changed: 15 additions & 13 deletions

File tree

docs/development.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@ Library Development
66
Backend development environment
77
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88

9-
virtualenv
9+
nox
1010
^^^^^^^^^^
1111

12-
Virtualenv is probably what you want to use during development. Once you
13-
have virtualenv installed, just fire up a shell and create your own
14-
environment.
12+
Install `nox <https://nox.thea.codes/en/stable/>`_.
13+
14+
This tool will help you to setup dev environment and run tests.
15+
16+
Following command will create a virtual environment and install all dependencies:
1517

1618
.. code:: bash
1719
18-
virtualenv venv
19-
source venv/bin/activate
20-
pip install -r requirements.dev.txt
20+
nox -s dev
21+
22+
Do not forget to activate the virtual environment before run any further commands.
2123

2224
Installing test data
2325
^^^^^^^^^^^^^^^^^^^^
@@ -89,4 +91,4 @@ You need to know at least one command; the one that runs all the tests:
8991

9092
.. code:: bash
9193
92-
nox
94+
nox -s unittest

docs/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Edit ``urls.py`` and include required urls
4444
# urls.py
4545
urlpatterns = (
4646
# ...
47-
url('^business-logic/', include('business_logic.urls')),
48-
url('^nested_admin/', include('nested_admin.urls')),
47+
re_path('^business-logic/', include('business_logic.urls')),
48+
re_path('^nested_admin/', include('nested_admin.urls')),
4949
# ...
5050
)
5151

docs/requirements.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ Requirements
33

44
This library requires the following:
55

6-
* Python (2.7, 3.4, 3.5, 3.6, 3.7)
7-
* Django (1.11, 2.0, 2.1) (for Django 1.8, 1.9, 1.10 try use 0.4.13 version)
8-
* django-rest-framework 3.8+
6+
* Python (3.8-3.11)
7+
* Django (3.2-4.2)
8+
* django-rest-framework 3.14+

0 commit comments

Comments
 (0)