[Python-Dev] [Python-checkins] peps: PEP for updating the URL layout on docs.python.org

Nick Coghlan ncoghlan at gmail.com
Sun Oct 28 13:08:36 CET 2012


On Sun, Oct 28, 2012 at 9:34 PM, Georg Brandl <g.brandl at gmx.net> wrote:
> Am 28.10.2012 12:29, schrieb Chris Jerdonek:
>> On Sat, Oct 27, 2012 at 7:36 AM, nick.coghlan
>> <python-checkins at python.org> wrote:
>>> http://hg.python.org/peps/rev/c7ba002ca91d
>>> changeset:   4568:c7ba002ca91d
>>> user:        Nick Coghlan <ncoghlan at gmail.com>
>>> date:        Sun Oct 28 00:36:36 2012 +1000
>>> summary:
>>>   PEP for updating the URL layout on docs.python.org
>>
>>> +* ``http://docs.python.org/x/*``
>>> +* ``http://docs.python.org/x.y/*``
>>> +* ``http://docs.python.org/release/x.y.z/*``
>>> +* ``http://docs.python.org/devguide``
>>> +
>>> +The ``/x/`` URLs mean "give me the latest documentation for this release
>>> +series``. Differences relative to previous versions in the release series
>>> +will be available through "version added" and "version changed" markers.
>>> +
>>> +The ``/x.y/`` URLs mean "give me the latest documentation for this release".
>>
>> It might be worth clarifying what "latest" means for both the "x" and
>> "x.y" forms.  For example, should "http://docs.python.org/3/" today
>> link to the released 3.3.0 version, the in-progress 3.3.1 version, or
>> the in-progress 3.4.0?
>
> I understand "latest" to mean "latest stable plus bugfixes".
> I.e., /3/ is 3.3.0+. /dev and /3.4 is 3.4a0.  It might need clarifying
> in the PEP.

Yes, I realised last night that it would be good to be more explicit
about this. The "release" hierarchy should be for versions exactly as
they were released, while the shorter ones draw directly from source
control (and thus may contain fixes which otherwise haven't been
released yet).

I updated the PEP to describe what Georg has put in place more
explicitly (initially I was going to propose a change to the way /dev/
URLs are handled, but then I realised what is already there made more
sense).

Cheers,
Nick.

-- 
Nick Coghlan   |   ncoghlan at gmail.com   |   Brisbane, Australia


More information about the Python-Dev mailing list