From e46231b289b731f026d6277c687e8ea92ca17e95 Mon Sep 17 00:00:00 2001 From: Nick Coghlan Date: Sun, 28 Oct 2012 22:06:46 +1000 Subject: [PATCH] Revert PEP 430 to Final. I realised the way Georg had already implemented this made more sense, so I just updated the PEP to reflect the new setup on docs.python.org --- pep-0430.txt | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/pep-0430.txt b/pep-0430.txt index f5fdb293d..00d8aac6f 100644 --- a/pep-0430.txt +++ b/pep-0430.txt @@ -4,7 +4,7 @@ Version: $Revision$ Last-Modified: $Date$ Author: Nick Coghlan BDFL-Delegate: Georg Brandl -Status: Draft +Status: Final Type: Informational Content-Type: text/x-rst Created: 27-Oct-2012 @@ -118,10 +118,6 @@ paths for the Python 2 docs are: The existing ``/py3k/`` subpath will be redirected to the new ``/3/`` subpath. -To help ensure future stability even of links to the in-development version, -the ``/dev/`` subpath will be redirected to the appropriate version specific -subpath (currently ``/3.4/``). - Presented URLs -------------- @@ -131,6 +127,7 @@ resolution of any aliasing and rewriting rules: * ``http://docs.python.org/x/*`` * ``http://docs.python.org/x.y/*`` +* ``http://docs.python.org/dev/*`` * ``http://docs.python.org/release/x.y.z/*`` * ``http://docs.python.org/devguide`` @@ -144,7 +141,7 @@ through "version added" and "version changed" markers. The ``/x.y/`` URLs mean "give me the latest documentation for this release". It will draw the documentation from the relevant maintenance branch in source control (or the default branch for the currently in development -version. It differs from the status quo in that the URLs will +version). It differs from the status quo in that the URLs will actually remain available in the user's browser for easy copy and pasting. (Currently, references to specific versions that are not the latest in their release series will resolve to a stable URL for a specific maintenance @@ -153,6 +150,9 @@ release series resolves to the release series URL. This makes it hard to get a "latest version specific URL", since it is always necessary to construct them manually). +The ``/dev/`` URL means the documentation for the default branch in source +control. + The ``/release/x.y.x/`` URLs will refer to the documentation of those releases, exactly as it was at the time of the release. @@ -186,6 +186,17 @@ Python 3.3 documentation. Namespaces are one honking great idea - let's do more of those. +Note that the approach described in this PEP gives two ways to access the +content of the default branch: as ``/dev/`` or using the appropriate +``/x.y/`` reference. This is deliberate, as the default branch is referenced +for two different purposes: + +* to provide additional information when discussing an upcoming feature of + the next release (a ``/x.y/`` URL is appropriate) +* to provide a stable destination for developers to access the documentation + of the next feature release, regardless of the version (a ``/dev/`` URL is + appropriate) + Implementation ==============