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: improve organization of the PyPI distutils docs
Type: enhancement Stage: resolved
Components: Distutils, Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: chris.jerdonek Nosy List: chris.jerdonek, eric.araujo, pitrou, python-dev, r.david.murray, tarek
Priority: normal Keywords: patch

Created on 2013-03-01 09:51 by chris.jerdonek, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue-pypi-docs.patch chris.jerdonek, 2013-03-01 09:51 review
Messages (5)
msg183252 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2013-03-01 09:51
This issue is to improve the organization of the PyPI section of the Distutils documentation, now that the information has been combined into one page.

A patch is attached.

Improvements include:

(1) Creating a section for command options common to both register and upload.  Previously, this information was confined to the upload section, even though the information was applicable to both commands.
(2) Separating general information about PyPI (e.g. PyPI user permissions and the web interface) from the information about Distutils command usage.
(3) Consolidating information about the .pypirc file in the .pypirc section.  Previously, some of the .pypirc information was spread throughout the upload section, even though the information is equally applicable to the register command.
msg206822 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-12-22 17:23
This looks good to me. It may also be worth changing example URLs to use "https" instead of "http", and mentioning the test PyPI server in the pypirc section: https://wiki.python.org/moin/TestPyPI

Chris, please proceed.
msg213339 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-03-13 00:02
+1
msg229179 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-10-12 17:16
New changeset 12536a991007 by R David Murray in branch '3.4':
#17325: Improve distutils PyPI documentation.
https://hg.python.org/cpython/rev/12536a991007

New changeset 8e4afcaa196c by R David Murray in branch 'default':
Merge: #17325: Improve distutils PyPI documentation.
https://hg.python.org/cpython/rev/8e4afcaa196c

New changeset 77098919f819 by R David Murray in branch '2.7':
#17325: Improve distutils PyPI documentation.
https://hg.python.org/cpython/rev/77098919f819
msg229181 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-10-12 17:18
Committed.  I changed the urls as suggested by Antoine.  I also added a link to the test pypi page, though I'm not sure what I did is exactly what Antoine had in mind.
History
Date User Action Args
2022-04-11 14:57:42adminsetgithub: 61527
2014-10-12 17:18:23r.david.murraysetstatus: open -> closed

nosy: + r.david.murray
messages: + msg229181

resolution: fixed
stage: commit review -> resolved
2014-10-12 17:16:07python-devsetnosy: + python-dev
messages: + msg229179
2014-03-13 00:02:47eric.araujosetmessages: + msg213339
2013-12-22 17:23:46pitrousetversions: - Python 3.2
nosy: + pitrou

messages: + msg206822

assignee: eric.araujo -> chris.jerdonek
stage: patch review -> commit review
2013-03-01 09:51:31chris.jerdonekcreate