Re: [Doc-SIG] better documentation on how to upload to PyPI
From: Michael Foord <fuzzyman@voidspace.org.uk> Date: Tue, Mar 2, 2010 at 5:53 PM Subject: Re: [Doc-SIG] better documentation on how to upload to PyPI To: Ian Bicking <ianb@colorstudy.com> Cc: Nick Coghlan <ncoghlan@gmail.com>, doc-sig@python.org
On 02/03/2010 20:54, Ian Bicking wrote:
On Tue, Mar 2, 2010 at 2:49 PM, Nick Coghlan <ncoghlan@gmail.com> wrote:
Ian Bicking wrote:
There's an effort to create a new set of documentation for packaging: http://guide.python-distribute.org/
Ideally this work will end up on docs.python.org <http://docs.python.org> at some point.
Would it be worth including a "See Also" or some other link in the main docs in the meantime? (the quick start there does appear to be the brief list of the basic steps that the main docs are missing)
Yes, I'm sure that would be quite helpful for readers.
If we make the change in 2.6-maint then it will be on the main docs when 2.6 is released. What documentation page should it go on?
I've added a link to the following page, but don't think that will be particularly effective:
Michael
Hello, I've asked Georg about the best location for the guide in the doc a few days ago since we planned to include it in docs.python.org during the summit. If the HH guide is included before it is finished as we have planned, maybe it could be included right now as part of the 2.6 maintenance as well. So the "See also link" would be an internal link in docs.python.org. I am proposing this to avoid maintaining guide.python-distribute.org *and* a section in docs.python.org once 2.7 is out. This will also avoid confusion for the community imho. Cheers Tarek -- Tarek Ziadé | http://ziade.org
On 03/03/2010 09:10, Tarek Ziadé wrote:
From: Michael Foord<fuzzyman@voidspace.org.uk> Date: Tue, Mar 2, 2010 at 5:53 PM Subject: Re: [Doc-SIG] better documentation on how to upload to PyPI To: Ian Bicking<ianb@colorstudy.com> Cc: Nick Coghlan<ncoghlan@gmail.com>, doc-sig@python.org
On 02/03/2010 20:54, Ian Bicking wrote:
On Tue, Mar 2, 2010 at 2:49 PM, Nick Coghlan<ncoghlan@gmail.com> wrote:
Ian Bicking wrote:
There's an effort to create a new set of documentation for packaging: http://guide.python-distribute.org/
Ideally this work will end up on docs.python.org <http://docs.python.org> at some point.
Would it be worth including a "See Also" or some other link in the main docs in the meantime? (the quick start there does appear to be the brief list of the basic steps that the main docs are missing)
Yes, I'm sure that would be quite helpful for readers.
If we make the change in 2.6-maint then it will be on the main docs when 2.6 is released. What documentation page should it go on?
I've added a link to the following page, but don't think that will be particularly effective:
Michael
Hello,
I've asked Georg about the best location for the guide in the doc a few days ago since we planned to include it in docs.python.org during the summit.
If the HH guide is included before it is finished as we have planned, maybe it could be included right now as part of the 2.6 maintenance as well.
So the "See also link" would be an internal link in docs.python.org. I am proposing this to avoid maintaining guide.python-distribute.org *and* a section in docs.python.org once 2.7 is out. This will also avoid confusion for the community imho.
See if Georg approves that. If he does I will leave it to you to check it into the documentation. All the best, Michael
Cheers Tarek
-- http://www.ironpythoninaction.com/ http://www.voidspace.org.uk/blog READ CAREFULLY. By accepting and reading this email you agree, on behalf of your employer, to release me from all obligations and waivers arising from any and all NON-NEGOTIATED agreements, licenses, terms-of-service, shrinkwrap, clickwrap, browsewrap, confidentiality, non-disclosure, non-compete and acceptable use policies (”BOGUS AGREEMENTS”) that I have entered into with your employer, its partners, licensors, agents and assigns, in perpetuity, without prejudice to my ongoing rights and privileges. You further represent that you have the authority to release me from any BOGUS AGREEMENTS on behalf of your employer.
participants (2)
-
Michael Foord -
Tarek Ziadé