Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#19437 closed Cleanup/optimization (fixed)

improved documentation for django installation

Reported by: dodger Owned by: dodger
Component: Documentation Version: 1.4
Severity: Normal Keywords: documentation
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

Documentation "topics/install" reads:

sudo pip install -e django-trunk/

In the newer installation instructions from code.djangoproject.com/ticket/19349:

pip install -e /path/to/your/local/clone/django/

The newer version properly explains that this is the path/to/django, but also that the last element is /django/ which reflects the proper subdirectory to be referenced with the pip command.

Change History (5)

comment:1 Changed 2 years ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

I believe topics/install is correct as you want to point pip install to the directory with setup.py, no? Perhaps the contributing tutorial should be clarified if it's not clear what directory /path/to/your/local/clone/django/ refers to.

comment:2 Changed 2 years ago by russellm

  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 2 years ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In 9f9a7f03d77e2b6002f841be42eccf8ff287f279:

Fixed #19437 - Clarified pip install instructions in contributing tutorial.

comment:4 Changed 2 years ago by Tim Graham <timograham@…>

In b86c3ddce88390dacc04094fbdce1b722fb8127b:

[1.5.x] Fixed #19437 - Clarified pip install instructions in contributing tutorial.

Backport of 9f9a7f03d7 from master

comment:5 Changed 2 years ago by Tim Graham <timograham@…>

In b86c3ddce88390dacc04094fbdce1b722fb8127b:

[1.5.x] Fixed #19437 - Clarified pip install instructions in contributing tutorial.

Backport of 9f9a7f03d7 from master

Note: See TracTickets for help on using tickets.
Back to Top