This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

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

Created on 2015-05-04 13:01 by skip.montanaro, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (3)
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 :(
msg407392 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2021-11-30 18:20
The legacy doc has this message in it now, so I think we can close this issue and trust Steve to deal with it along with the rest of distutils.


   The entire ``distutils`` package has been deprecated and will be
   removed in Python 3.12. This documentation is retained as a
   reference only, and will be removed with the package. See the
   :ref:`What's New <distutils-deprecated>` entry for more information.
History
Date User Action Args
2022-04-11 14:58:16adminsetgithub: 68312
2021-11-30 18:20:31iritkatrielsetstatus: open -> closed

nosy: + iritkatriel, steve.dower
messages: + msg407392

resolution: not a bug
stage: resolved
2015-05-06 08:01:24ncoghlansetmessages: + msg242650
2015-05-05 20:31:46ned.deilysetnosy: + ncoghlan
2015-05-04 13:01:36skip.montanarocreate