Add a version switcher to python docs site

[ezio.melotti]

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py
File Doc/conf.py (right):

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py#newcode72
Doc/conf.py:72: html_short_title = 'Documentation'
I would leave this unchanged, in order to have the right title when js is not
available.

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/layout.html
File Doc/tools/sphinxext/layout.html (right):

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/layout.html...
Doc/tools/sphinxext/layout.html:7: <span id="version_switcher">{{ release
}}</span>
This should probably be wrapped in an {% if not embedded %}

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/static/vers...
File Doc/tools/sphinxext/static/version_switch.js (right):

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/static/vers...
Doc/tools/sphinxext/static/version_switch.js:4: var all_versions = ['3.4',
'3.3', '3.2', '3.1', '3.0',
I would drop 3.0 for sure, and possibly even 3.1 and >=2.4/5.
The 3.4 version should have some kind of marker to show that it's the
in-development version (something like 'dev (3.4)').

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/static/vers...
Doc/tools/sphinxext/static/version_switch.js:46: var url_re =
/\.org\/(py3k|release\/\d\.\d[\w\d\.]*|\d\.\d[\w\d\.]*)\//,
(py3k|release\/\d\.\d[\w\d\.]*|\d\.\d[\w\d\.]*) is equal to
(py3k|(?:release\/)?\d\.\d[\w\d\.]*)

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/static/vers...
Doc/tools/sphinxext/static/version_switch.js:46: var url_re =
/\.org\/(py3k|release\/\d\.\d[\w\d\.]*|\d\.\d[\w\d\.]*)\//,
It would be nice if this also worked on local copies of the doc, but that
depends on the dir layout.

[Yury.Selivanov]

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py
File Doc/conf.py (right):

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py#newcode72
Doc/conf.py:72: html_short_title = 'Documentation'
On 2012/10/26 19:48:52, ezio.melotti wrote:
> I would leave this unchanged, in order to have the right title when js is not
> available.

Eric,

If JS is not available, then '''<span id="version_switcher">''' will contain the
release number, hence, for the user it will look like docs without this patch
applied.

[Yury.Selivanov]

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/static/vers...
File Doc/tools/sphinxext/static/version_switch.js (right):

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/static/vers...
Doc/tools/sphinxext/static/version_switch.js:4: var all_versions = ['3.4',
'3.3', '3.2', '3.1', '3.0',
On 2012/10/26 19:48:52, ezio.melotti wrote:
> I would drop 3.0 for sure, and possibly even 3.1 and >=2.4/5.
> The 3.4 version should have some kind of marker to show that it's the
> in-development version (something like 'dev (3.4)').

Allright.

[Yury.Selivanov]

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/layout.html
File Doc/tools/sphinxext/layout.html (right):

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/layout.html...
Doc/tools/sphinxext/layout.html:7: <span id="version_switcher">{{ release
}}</span>
On 2012/10/26 19:48:52, ezio.melotti wrote:
> This should probably be wrapped in an {% if not embedded %}

Well, in the current patch it shouldn't be, as {{ shorttitle }} will just
display 'Documentation', and the <span> will display a release number.  Together
they look like they looked before the patch...

[ezio.melotti]

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py
File Doc/conf.py (right):

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py#newcode72
Doc/conf.py:72: html_short_title = 'Documentation'
On 2012/10/26 19:53:25, yselivanov wrote:
> On 2012/10/26 19:48:52, ezio.melotti wrote:
> > I would leave this unchanged, in order to have the right title when js is
not
> > available.
> 
> Eric,
> 
> If JS is not available, then '''<span id="version_switcher">''' will contain
the
> release number, hence, for the user it will look like docs without this patch
> applied.

Fair enough, assuming that this is true for all the places where
html_short_title was previously used (if there are more than one).

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/layout.html
File Doc/tools/sphinxext/layout.html (right):

http://bugs.python.org/review/16331/diff/6400/Doc/tools/sphinxext/layout.html...
Doc/tools/sphinxext/layout.html:7: <span id="version_switcher">{{ release
}}</span>
On 2012/10/26 19:56:45, yselivanov wrote:
> On 2012/10/26 19:48:52, ezio.melotti wrote:
> > This should probably be wrapped in an {% if not embedded %}
> 
> Well, in the current patch it shouldn't be, as {{ shorttitle }} will just
> display 'Documentation', and the <span> will display a release number. 
Together
> they look like they looked before the patch...

OK

[Yury.Selivanov]

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py
File Doc/conf.py (right):

http://bugs.python.org/review/16331/diff/6400/Doc/conf.py#newcode72
Doc/conf.py:72: html_short_title = 'Documentation'
On 2012/10/26 20:34:11, ezio.melotti wrote:
> On 2012/10/26 19:53:25, yselivanov wrote:
> > On 2012/10/26 19:48:52, ezio.melotti wrote:
> > > I would leave this unchanged, in order to have the right title when js is
> not
> > > available.
> > 
> > Eric,
> > 
> > If JS is not available, then '''<span id="version_switcher">''' will contain
> the
> > release number, hence, for the user it will look like docs without this
patch
> > applied.
> 
> Fair enough, assuming that this is true for all the places where
> html_short_title was previously used (if there are more than one).

I' check that.  Don't apply this version of the patch please ;)