classification
Title: Two versions of instructions for installing Python modules
Type: Stage:
Components: Documentation Versions: Python 3.5
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ncoghlan, skip.montanaro
Priority: normal Keywords:

Created on 2015-05-04 13:01 by skip.montanaro, last changed 2015-05-06 08:01 by ncoghlan.

Messages (2)
msg242555 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2015-05-04 13:01
I was hunting around the current website for notes on installing Python. Couldn't find any (BTW), so I looked in the Python source. Imagine my surprise to find two apparently overlapping files describing how to build Python modules:

./Doc/install/index.rst
./Doc/installing/index.rst

The former is marked "Legacy version." The latter seems to cover mostly installation of third-party modules using tools like pip. The former covers distutils.  Oddly enough, the "legacy" version seems to have been updated more recently than the presumably current version. Do we really need to keep both versions around at this point? Should they be merged into a single document? If they are to both be retained, should the legacy version be marked as such more clearly and refer readers to the pip/pyvenv/virtualenv version?
msg242650 - (view) Author: Nick Coghlan (ncoghlan) * (Python committer) Date: 2015-05-06 08:01
As far as I'm aware, it's only confusing if you're poking around in the source tree, rather than using the built docs at docs.python.org (where the link to the legacy docs is now hidden away inside the distutils module docs).

The legacy docs remain in place to preserve existing deep links and because they're the only current documentation of various distutils details that are needed to *implement* tools like pip and setuptools.

In a more ideal world, we'd have a distutils expert with the time to go through the legacy docs, cull the outdated stuff, and lift the rest up into the distutils module documentation, but all the folks that might plausibly have the expertise to do that also have far more interesting things to do with their time :(
History
Date User Action Args
2015-05-06 08:01:24ncoghlansetmessages: + msg242650
2015-05-05 20:31:46ned.deilysetnosy: + ncoghlan
2015-05-04 13:01:36skip.montanarocreate