diff options
| author | Ad Timmering <awtimmering@gmail.com> | 2019-10-12 11:44:37 +0900 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-10-15 12:54:44 +0200 |
| commit | 18631226da2fb75d40e73df8f1049f928848f794 (patch) | |
| tree | beeddc0cb60ac1c7a901848cd1dbf94c96a8bf0d | |
| parent | 9adb80efee83445763d303f9ee57b3c4ba9e5cbc (diff) | |
[3.0.x] Fixed #30816 -- Doc'd how to create projects with a local copy of Django.
Backport of dee687e93a2d45e9fac404be2098cc4707d31c1f from master
| -rw-r--r-- | docs/intro/contributing.txt | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index b21ec57f6d..b654d25817 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -177,15 +177,27 @@ command line to help you keep track of which one you are using. Anything you install through ``pip`` while this name is displayed will be installed in that virtual environment, isolated from other environments and system-wide packages. +.. _intro-contributing-install-local-copy: + Go ahead and install the previously cloned copy of Django: .. console:: $ python -m pip install -e /path/to/your/local/clone/django/ -The installed version of Django is now pointing at your local copy. You will -immediately see any changes you make to it, which is of great help when writing -your first patch. +The installed version of Django is now pointing at your local copy by installing +in editable mode. You will immediately see any changes you make to it, which is +of great help when writing your first patch. + +Creating projects with a local copy of Django +--------------------------------------------- + +It may be helpful to test your local changes with a Django project. First you +have to create a new virtual environment, :ref:`install the previously cloned +local copy of Django in editable mode <intro-contributing-install-local-copy>`, +and create a new Django project outside of your local copy of Django. You will +immediately see any changes you make to Django in your new project, which is +of great help when writing your first patch. Running Django's test suite for the first time ============================================== |
