Mailman 3 March 2010 - Doc-SIG

Re: [Doc-SIG] better documentation on how to upload to PyPI
by Tarek Ziadé March 3, 2010

March 3, 2010

> From: Michael Foord <fuzzyman(a)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(a)colorstudy.com> > Cc: Nick Coghlan <ncoghlan(a)gmail.com>, doc-sig(a)python.org > > > On 02/03/2010 20:54, Ian Bicking wrote: > > On Tue, Mar 2, 2010 at 2:49 PM, Nick Coghlan <ncoghlan(a)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: > > http://python.org/doc/ > > 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

2 1

better documentation on how to upload to PyPI
by Dr. Phillip M. Feldman March 3, 2010

March 3, 2010

The procedure for uploading to PyPI is not well documented. I had to read several different docs and do some experimentation before coming up with the following: Procedure for uploading to the Python Package Index (PyPI): 1. Create setup.py file. 2. Create ".pypirc" file if it does not already exist. 3. Launch IPython. 4. Issue the command "run setup register" 5. Issue the command "run setup sdist upload". 6. Log into PyPI and adjust visibility of old versions as necessary. I'd like to see this list of steps (or something similar) in the docs. -- View this message in context: http://old.nabble.com/better-documentation-on-how-to-upload-to-PyPI-tp26748… Sent from the Python - doc-sig mailing list archive at Nabble.com.

5 5

pydoc gui enhancement
by Ron Adam March 2, 2010

March 2, 2010

Hi, just updated this patch so it works with Python version 3.2. http://bugs.python.org/issue2001 What it does is add a navigation bar at the top of the web pages so you can do the following. + Shows what version of python you are browsing/using. + Get an item - It takes the same input as the help() function does in the console. + Search - Returns the same result as the tkinter search box. + Module index - The normal default top level. + Topics - lists all the topics. They can be clicked on and the results are displayed with xrefs that can be clicked on. + Keywords - Lists all the keywords. Works the same as Topics. Also the file links are read in as text and served as a pydoc page instead of relying on the browsers file reading capability. That is much safer and gives a better file listing. This patch removes the tkinter search bar sense it's no longer needed. tkinter is no longer needed for pydoc to run in gui mode. It really makes browsing pythons library a breeze. If someone can try it out and give me some additional feedback as to possibly any problems or any changes I need to make it would be nice. Thanks, Ron Adam

1 0