documentation version switcher is broken

[1st1]

BPO	25113
Nosy	@birkenfeld, @larryhastings, @ned-deily, @ezio-melotti, @merwok, @berkerpeksag, @1st1

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2015-09-15.17:47:17.171>
created_at = <Date 2015-09-14.19:32:14.049>
labels = ['type-bug']
title = 'documentation version switcher is broken'
updated_at = <Date 2015-09-16.20:13:13.636>
user = 'https://github.com/1st1'

bugs.python.org fields:

activity = <Date 2015-09-16.20:13:13.636>
actor = 'BreamoreBoy'
assignee = 'none'
closed = True
closed_date = <Date 2015-09-15.17:47:17.171>
closer = 'berker.peksag'
components = []
creation = <Date 2015-09-14.19:32:14.049>
creator = 'yselivanov'
dependencies = []
files = []
hgrepos = []
issue_num = 25113
keywords = []
message_count = 8.0
messages = ['250700', '250702', '250730', '250732', '250788', '250851', '250855', '250862']
nosy_count = 8.0
nosy_names = ['georg.brandl', 'larry', 'ned.deily', 'ezio.melotti', 'eric.araujo', 'BreamoreBoy', 'berker.peksag', 'yselivanov']
pr_nums = []
priority = 'high'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue25113'
versions = ['Python 3.5']

[1st1]

The dropdown that allowed to switch the Python version for docs disappeared with py3.5 release.

[berkerpeksag]

Looks like version_switch.js is not included into HTML.

SPHINXOPTS='-A versionswitcher=1' make -C Doc/ htmlview

works for me locally on the 3.5 branch. Perhaps 3.5 docs were created manually or without running "make autobuild-{dev,html,stable}"?

[larryhastings]

When I built the documentation, I used

% release.py --export 3.5.0

(release.py coming from hg.python.org/release, a collection of release manager tools.) I then installed this build as the 3.5.0 documentation, specifically the build from "python-3.5.0-docs-html.tar.bz2". I do that so that people don't complain "hey the documentation is out of date!" when the release goes live. I wouldn't be surprised if the version picker is suppressed in this build, as it's intended to be installed by users.

However, there's a cron job that rebuilds the documentation automatically. I'm not sure how often, but I think it's every couple of hours. That build process, whatever it is, should definitely enable the version picker.

Normally the cron job would have overwritten the docs by now. However I just discovered I left the docs non-group-writeable when I installed them, which meant the cron job couldn't overwrite them. I just fixed that, and hopefully within a couple of hours the cron job will awake from its slumber and overwrite everything.

tl;dr: Hopefully it'll silently fix itself sometime today.

[birkenfeld]

NM.

[berkerpeksag]

tl;dr: Hopefully it'll silently fix itself sometime today.

Yes, it's working now. Thanks for the explanation.

[1st1]

The switcher isn't visible on all pages, I suspect we need to bust caches on cdns/varnish

[ned-deily]

We are pursuing the stale CDN cache issue with #python-infra. It appears that, as it stands, the cached doc pages will expire within a week.

[BreamoreBoy]

This wasn't working for me earlier but it is now at 21:11 BST so I'd assume we can leave this closed.