[Python-Dev] http://www.python.org/dev/doc/devel still available

Fred L. Drake, Jr. fdrake at acm.org
Wed Feb 15 05:40:53 CET 2006

On Tuesday 14 February 2006 03:09, Neal Norwitz wrote:
 > While you are here, are you planning to do the doc releases for 2.5?
 > You are tentatively listed in PEP 356.  (Technically it says TBD with
 > a ? next to your name.)

Releases generally aren't a problem, since they're heavily automated and 
scheduled well in advance.  I'm glad to continue helping with that, 
especially since that seems to be about all I can get to sometimes.

 > I think this was the quick hack I did.  I hope there are many
 > concerns. :-)  For example, if the doc build fails, ...  Hmmm, this
 > probably isn't a problem.  The doc won't be updated, but will still be
 > the last good version.  So if I send mail when the doc doesn't build,
 > then it might not be so bad.  

Seems reasonable to me.

 > I still need to 
 > switch over the failure mails to go to python-checkins.  There are too 
 > many right now though.  Unless people don't mind getting several
 > messages about refleaks every day?  Anyone?

Documentation build errors should probably be separated from leak detection 
reports.  I don't know what it would take to get them separated.

 > That shouldn't be a problem.  See http://docs.python.org/dev/2.4/

Works for me!  Thanks for putting the effort into this.

The general question of where the development docs should show up remains.  
There are a number of options:

1. www.python.org/dev/doc/, where I'd put them at one point

2. www.python.org/doc/..., which is reasonable, but new

3. docs.python.org/dev/, which seems reasonable, but docs.python.org
   proponents may not like

4. www.python.org/dev/doc/ for trunk documentation, and
   docs.python.org/ and/or www.python.org/doc/current/ for maintenance updates

That last one has a certain appeal.  It would allow corrections to go online 
quicker, so people using python.org or a mirror would get updates quickly (an 
advantage of delivering docs over the net!), and I wouldn't get so many 
repeat reports of commonly-noticed typos.  The released versions would still 
be available via www.python.org/doc/x.y.z/.

My own inclination is that if we continue to use docs.python.org, it should 
contain only one copy of the documentation, and that should be for the most 
recent "stable" release (though perhaps an updated version of the 
documentation).  I'm not really on either side of the fence about whether 
docs.python.org is the "right thing" to do; the idea came out of the folks 
interested in advocacy.


Fred L. Drake, Jr.   <fdrake at acm.org>

More information about the Python-Dev mailing list