#28343 closed Cleanup/optimization (fixed)

Update the Windows instructions in the docs to use py launcher rather than Git bash

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

Description (last modified by Tim Graham)

Python installations on Windows now:

  • Ship the PEP397 py launcher which reduces the need to either having to add python.exe directory to PATH or having to always specify its full path. It also can detect your Python's python.exe even when it's invoked from inside a virtualenv.
  • Have a better "Execute manage.py or runtest.py by simply running them" story when compared to previous Python versions, thanks partially to the above mentioned launcher.

This would allow us to reduce special casing of Windows when describing command line interactions. In particular IMHO the suggestion to use the Git for Windows Bash shell can be dropped from the contributing tutorial as it doesn't actually make things easier.

Change History (6)

comment:1 Changed 21 months ago by Ramiro Morales

Has patch: set

comment:2 Changed 21 months ago by Tim Graham

Description: modified (diff)
Summary: Documentation for Windows users can be simpler now that we only support Python >= 3.5Update the Windows instructions in the docs to use py launcher rather than Git bash
Triage Stage: UnreviewedAccepted

comment:3 Changed 21 months ago by Ramiro Morales

A short screencast of how the new custom Sphinx directive works http://i.imgur.com/00oSOXU.gifv

comment:4 Changed 21 months ago by Tim Graham

Patch needs improvement: set

The djangoproject.com website doesn't use the sphinx theme, so separate changes are needed for this to work there.

A usability improvement would be for the operating system selector above the code blocks to toggle all blocks on the page rather than each individual block. It's annoying to follow the tutorial and have to click to change to Windows each time. For the website, I wonder if it would be worth trying to persist the user's choice in a cookie (and/or even try to pull it from the browser's user agent).

It could be useful to post about this effort on the DevelopersMailingList, just to make sure other Windows users are in agreement with these changes.

comment:5 in reply to:  4 Changed 21 months ago by Ramiro Morales

Patch needs improvement: unset

Replying to Tim Graham:

The djangoproject.com website doesn't use the sphinx theme, so separate changes are needed for this to work there.

Done. See PR at https://github.com/django/djangoproject.com/pull/776

A usability improvement would be for the operating system selector above the code blocks to toggle all blocks on the page rather than each individual block. It's annoying to follow the tutorial and have to click to change to Windows each time.

Done, the PR has been updated. Also see http://imgur.com/3ce03UT

For the website, I wonder if it would be worth trying to persist the user's choice in a cookie (and/or even try to pull it from the browser's user agent).

Still nor done.

It could be useful to post about this effort on the DevelopersMailingList, just to make sure other Windows users are in agreement with these changes.

Done.. See https://groups.google.com/d/msg/django-developers/2INTyJOLMK0/zJ_QlsMfAQAJ

comment:6 Changed 14 months ago by Tim Graham <timograham@…>

Resolution: fixed
Status: assignedclosed

In 37c1784:

Fixed #28343 -- Add an OS chooser for docs command line examples.

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