This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: documentation version switcher is broken
Type: behavior Stage: resolved
Components: Versions: Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: BreamoreBoy, berker.peksag, eric.araujo, ezio.melotti, georg.brandl, larry, ned.deily, yselivanov
Priority: high Keywords:

Created on 2015-09-14 19:32 by yselivanov, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Messages (8)
msg250700 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2015-09-14 19:32
The dropdown that allowed to switch the Python version for docs disappeared with py3.5 release.
msg250702 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-09-14 20:44
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}"?
msg250730 - (view) Author: Larry Hastings (larry) * (Python committer) Date: 2015-09-15 08:02
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.
msg250732 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2015-09-15 08:07
NM.
msg250788 - (view) Author: Berker Peksag (berker.peksag) * (Python committer) Date: 2015-09-15 17:47
> tl;dr: Hopefully it'll silently fix itself sometime today.

Yes, it's working now. Thanks for the explanation.
msg250851 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2015-09-16 16:12
The switcher isn't visible on all pages, I suspect we need to bust caches on cdns/varnish
msg250855 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2015-09-16 17:04
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.
msg250862 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2015-09-16 20:13
This wasn't working for me earlier but it is now at 21:11 BST so I'd assume we can leave this closed.
History
Date User Action Args
2022-04-11 14:58:21adminsetgithub: 69300
2015-09-16 20:13:13BreamoreBoysetnosy: + BreamoreBoy
messages: + msg250862
2015-09-16 17:04:38ned.deilysetnosy: + ned.deily
messages: + msg250855
2015-09-16 16:12:57yselivanovsetmessages: + msg250851
2015-09-15 17:47:17berker.peksagsetstatus: open -> closed
type: enhancement -> behavior
messages: + msg250788

resolution: fixed
stage: resolved
2015-09-15 08:07:33georg.brandlsetmessages: + msg250732
2015-09-15 08:07:25georg.brandlsetmessages: - msg250731
2015-09-15 08:06:25georg.brandlsetmessages: + msg250731
2015-09-15 08:02:16larrysetmessages: + msg250730
2015-09-14 20:44:34berker.peksagsetnosy: + berker.peksag
messages: + msg250702
2015-09-14 19:32:14yselivanovcreate