
This issue trackerhas been migrated toGitHub, and is currentlyread-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.
Created on2013-10-26 12:44 byncoghlan, last changed2022-04-11 14:57 byadmin. This issue is nowclosed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| issue19407_packaging_docs.diff | ncoghlan,2014-03-08 14:13 | WIP patch (new guides are placeholders) | review | |
| Messages (23) | |||
|---|---|---|---|
| msg201343 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-10-26 12:44 | |
Updating the "Installing Python Modules" docs in 2.7, 3.3 and default to recommend pip as the default cross-platform installer. | |||
| msg201344 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-10-26 12:45 | |
Onceissue 19406 is implemented, this will need an additional update to indicate pip should be available by default in 3.4. | |||
| msg201348 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-10-26 12:48 | |
Issue 19347 tracks overallPEP 453 implementation progress | |||
| msg201711 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-10-30 05:40 | |
Marcus Smith (aka @qwcode) has made good strides this week in getting the Python Packaging User Guide to a presentable state using the current Python docs theme.Bootstrapping:https://python-packaging-user-guide.readthedocs.org/en/latest/setup.htmlUsage:https://python-packaging-user-guide.readthedocs.org/en/latest/installation.htmlAccordingly, I think it makes sense to:1. Arrange for a copy of this guide to be hosted somewhere on docs.python.org2. Refer to that from the per-version distutils guides rather than referring directly to pip-installer.orgThoughts? | |||
| msg201737 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-10-30 14:18 | |
Alternative (more sensible) option - leave the packaging user guide hosted on ReadTheDocs, and if we decide to add a python.org subdomain for it later, that won't break any existing links. | |||
| msg202531 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-11-10 15:07 | |
Larry, just a heads up that as a docs patch that isn't directly affected by the feature freeze, I likely won't get to this one until after beta 1.We'll make sureissue 19406 and the other functional changes are resolved, though. | |||
| msg205786 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2013-12-10 10:49 | |
After reviewing the Extending & Embedding docs recently, I think a disclaimer/redirect to the tool recommendations in the Python Packaging User Guide is appropriate there as well.Marcus also added an issue to update the distutils docs themselves:https://bitbucket.org/pypa/python-packaging-user-guide/issue/29/modernize-distutils-docs(The user guide tracker is currently serving as a metatracker for docs issues for all the core tools) | |||
| msg205789 -(view) | Author: Roundup Robot (python-dev)![]() | Date: 2013-12-10 11:19 | |
New changeseta9f91a38a265 by Nick Coghlan in branch '2.7':Issue#19407: add Python Packaging User Guide noteshttp://hg.python.org/cpython/rev/a9f91a38a265 | |||
| msg205792 -(view) | Author: Roundup Robot (python-dev)![]() | Date: 2013-12-10 11:32 | |
New changeset16b7536e418b by Nick Coghlan in branch '3.3':Issue#19407: add Python Packaging User Guide noteshttp://hg.python.org/cpython/rev/16b7536e418bNew changesetbc21da9727ad by Nick Coghlan in branch 'default':Issue#19407: merge PPUG notes from 3.3http://hg.python.org/cpython/rev/bc21da9727ad | |||
| msg207175 -(view) | Author: Martin v. Löwis (loewis)*![]() | Date: 2014-01-02 16:54 | |
I suggest that a documentation issue cannot be a release blocker. Most people read the documentation online, and will read an update once it is available. | |||
| msg207201 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2014-01-03 02:19 | |
Agreed, this was set to ensure Larry followed up with a "Please explain" ifI didn't get it done in a timely manner.I'll still try to get it done for the beta, but I still havelinux.conf.aupreparation to do, so it may slip to the first RC. | |||
| msg212928 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2014-03-08 12:46 | |
After attempting to fix these docs in place, I now think that's a doomed effort. However, we can't just delete them, because they still contain details that haven't been moved to the distutils module docs or the Python Packaging User Guide yet.So, what I'm planning to do instead is leave the existingDoc/install andDoc/distutils directories alone (including all their labels), changing the top level index page to point to newDoc/installing andDoc/distributing directories, and add a link to the old guides from the distutils docs page.That will keep the legacy docs available, while removing all the confusing legacy cruft from the new end user facing docs (which can now just be very brief before redirecting to packaging.python.org). | |||
| msg212931 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2014-03-08 14:13 | |
I like the way the attached patch has worked out - I think it's complete from a structural point of view.The two missing pieces are to fill in the contents for the new Installing and Distributing guides, and those will be kept deliberately short, since we want to minimise the duplicating of content from the Python Packaging User Guide. | |||
| msg212943 -(view) | Author: Marcus Smith (Marcus.Smith)![]() | Date: 2014-03-08 18:31 | |
"Legacy version". nice. btw, "http://packaging.python.org/en/latest/tutorial.html#creating-and-using-virtual-environments" will certainly end up including "pyvenv" command examples as well. currently just mentioned in a footnote.like I mentioned on distutils-sig, I still hope to submit a patch to move critical content from the legacy pages to library/distutils.rst at some point.also, btw, maybe you can fix this page real quick?http://www.python.org/documentation/. not sure what repo/team is managing this, but it's referencing the old HHGTP. | |||
| msg212946 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2014-03-08 23:37 | |
Thanks for the feedback!Could you lob that last one at the pythondotorg issue tracker on GitHub (https://github.com/python/pythondotorg/issues)? | |||
| msg212947 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2014-03-08 23:44 | |
And regarding moving the still-relevant content to the main distutils docs,yeah that's still a good idea. However, that's going to take a fair bitmore work, since you'll need to evaluate the legacy content to decide whatneeds preserving, and I don't know the technical details well enough tomake that call.I figure the approach in my patch is a neat hack to move that task off thePython 3.4 critical path, while still giving new Python 3.4 users a cleanand authoritative starting point for packaging issues :) | |||
| msg213118 -(view) | Author: Marcus Smith (Marcus.Smith)![]() | Date: 2014-03-11 05:35 | |
about the hhgtp link, logged here:https://github.com/python/pythondotorg/issues/268 (and already fixed)also, pyvenv is more prominent now in PUG as of latest changes (seehttps://github.com/pypa/python-packaging-user-guide/pull/35) | |||
| msg213199 -(view) | Author: Éric Araujo (eric.araujo)*![]() | Date: 2014-03-12 05:36 | |
Left some comments for Nick on Rietveld (the ever-useful CC name selection did not let me find you, so you may have not gotten a mail). | |||
| msg213388 -(view) | Author: Roundup Robot (python-dev)![]() | Date: 2014-03-13 12:14 | |
New changesetd22ef969cb82 by Nick Coghlan in branch 'default':Close#19407: New installation & distribution guideshttp://hg.python.org/cpython/rev/d22ef969cb82 | |||
| msg213389 -(view) | Author: Alyssa Coghlan (ncoghlan)*![]() | Date: 2014-03-13 12:17 | |
Not sure how much I'll be online tomorrow or Saturday, so I went ahead and committed what I had.The new guides definitely aren't perfect, but I think they're in acceptable shape for 3.4.0, and we can improve them in parallel with Python Packaging User Guide updates (e.g. there were some "How do I...?" questions I left unanswered because the relevant PPUG sections don't have answers yet. In particular, I completely punted on the non-PyPI distribution question for now) | |||
| msg213391 -(view) | Author: Roundup Robot (python-dev)![]() | Date: 2014-03-13 12:33 | |
New changesetf5be4ea5b43e by Nick Coghlan in branch 'default':Issue#19407: fix linkhttp://hg.python.org/cpython/rev/f5be4ea5b43e | |||
| msg213450 -(view) | Author: Roundup Robot (python-dev)![]() | Date: 2014-03-13 19:43 | |
New changeset25dc02a2acae by Ned Deily in branch 'default':Issue#19407: Fix typos in new distribution & installation guides.http://hg.python.org/cpython/rev/25dc02a2acae | |||
| msg253897 -(view) | Author: Jon Snoo (Jon Snoo) | Date: 2015-11-02 07:34 | |
The link to the "quick recommendations section" in the Python 2.7 and 3.3 docs is broken. It appears that the PPUG has changed the path fromhttps://python-packaging-user-guide.readthedocs.org/en/latest/current.htmltohttps://python-packaging-user-guide.readthedocs.org/en/latest/current/Also, should the "Installing Python Modules" in Python 2.7.9 and 2.7.10 be the same as the one in Python 3.4? After all, pip is included in Python 2.7.9+, isn't it? | |||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:57:52 | admin | set | github: 63606 |
| 2015-11-02 07:34:28 | Jon Snoo | set | nosy: +Jon Snoo messages: +msg253897 |
| 2014-03-13 19:43:21 | python-dev | set | messages: +msg213450 |
| 2014-03-13 12:33:52 | python-dev | set | messages: +msg213391 |
| 2014-03-13 12:17:17 | ncoghlan | set | messages: +msg213389 |
| 2014-03-13 12:14:04 | python-dev | set | status: open -> closed resolution: fixed messages: +msg213388 stage: resolved |
| 2014-03-12 05:36:15 | eric.araujo | set | messages: +msg213199 |
| 2014-03-11 05:35:15 | Marcus.Smith | set | messages: +msg213118 |
| 2014-03-10 18:32:31 | eric.araujo | set | nosy: +eric.araujo |
| 2014-03-08 23:44:33 | ncoghlan | set | messages: +msg212947 |
| 2014-03-08 23:37:45 | ncoghlan | set | messages: +msg212946 |
| 2014-03-08 18:31:28 | Marcus.Smith | set | messages: +msg212943 |
| 2014-03-08 14:13:25 | ncoghlan | set | files: +issue19407_packaging_docs.diff keywords: +patch messages: +msg212931 |
| 2014-03-08 12:46:01 | ncoghlan | set | nosy: +Marcus.Smith messages: +msg212928 versions: - Python 2.7, Python 3.3 |
| 2014-01-03 05:20:09 | ncoghlan | unlink | issue19347 dependencies |
| 2014-01-03 05:15:20 | ncoghlan | set | priority: release blocker -> deferred blocker |
| 2014-01-03 02:19:56 | ncoghlan | set | messages: +msg207201 |
| 2014-01-02 16:54:53 | loewis | set | nosy: +loewis messages: +msg207175 |
| 2013-12-10 11:32:38 | python-dev | set | messages: +msg205792 |
| 2013-12-10 11:19:25 | python-dev | set | nosy: +python-dev messages: +msg205789 |
| 2013-12-10 10:49:50 | ncoghlan | set | priority: deferred blocker -> release blocker messages: +msg205786 |
| 2013-11-22 14:42:01 | ncoghlan | set | priority: release blocker -> deferred blocker |
| 2013-11-10 15:07:05 | ncoghlan | set | messages: +msg202531 |
| 2013-10-30 14:18:35 | ncoghlan | set | messages: +msg201737 |
| 2013-10-30 05:40:12 | ncoghlan | set | messages: +msg201711 |
| 2013-10-28 12:59:02 | dstufft | set | nosy: +dstufft |
| 2013-10-26 12:49:16 | ncoghlan | set | messages: -msg201346 |
| 2013-10-26 12:48:47 | ncoghlan | set | messages: +msg201348 |
| 2013-10-26 12:48:16 | ncoghlan | set | messages: +msg201346 |
| 2013-10-26 12:46:17 | ncoghlan | link | issue19347 dependencies |
| 2013-10-26 12:45:27 | ncoghlan | set | dependencies: +PEP 453: add the ensurepip module messages: +msg201344 |
| 2013-10-26 12:44:35 | ncoghlan | create | |