[issue13122] Out of date links in the sidebar of the documentation index of versions 3.1 and 3.2
New submission from Sven Marnach sven@marnach.net:
The sidebar on http://docs.python.org/release/3.1.3/ names 3.2 as the development version of Python, while the link points to 3.3. The sidebar on http://docs.python.org/py3k/ links to 3.1 as the "stable version" -- obviously a relict from the time when 3.2 was in development. (This could be fixed in Doc/tools/sphinxext/indexsidebar.html of the respective branches.)
---------- assignee: docs@python components: Documentation messages: 145084 nosy: docs@python, smarnach priority: normal severity: normal status: open title: Out of date links in the sidebar of the documentation index of versions 3.1 and 3.2 versions: Python 3.1, Python 3.2
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Changes by Ned Deily nad@acm.org:
---------- nosy: +georg.brandl
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Ezio Melotti ezio.melotti@gmail.com added the comment:
AFAIK the doc for 3.1 is not rebuilt anymore, so even if it's fixed, the change won't have any visible effect -- unless someone manually triggers a rebuild. Regarding the 3.1 link on the py3k page: I think 'stable' still applies, even if it only receives security fixes.
---------- nosy: +ezio.melotti
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
I disagree about 3.2 not being 'stable'. With more bugs fixes, it should be more stable. People should be encouraged to download 3.2. 2.7 came out 8 months before, and that should be updated (and again when 3.3 comes out).
---------- nosy: +terry.reedy
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Georg Brandl georg@python.org added the comment:
Nobody said 3.2 was not stable...
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Sandro Tosi sandro.tosi@gmail.com added the comment:
Hi all, how can we fix it? or better, should we fix it? From a user POV, it is a weird to see 3.1 doc referring to 3.2 doc as "in development" then clicking on that link, being redirect to 3.3a0 doc and see there that 3.2 is stable (with no reference back to 3.1).
Maybe we can adjust the sidebar in 3.1 references and do a manual rebuild or just wait for another security release? maybe we can discuss a policy for such things and write it in stone (aka devguide).
---------- nosy: +sandro.tosi
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
http://docs.python.org/release/2.6.7/ has the same problem that the 3.x 'in development' version is called 3.2, while there is no link to current stable 3.2.2 except indirectly by going to 'old versions' (which perhaps should be 'other versions'). I do not know enough about frames to know how to future-proof the sidebar better.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Antoine Pitrou pitrou@free.fr added the comment:
Nobody said 3.2 was not stable...
Well, the sidebar says it's in development while 2.7 is stable :)
---------- nosy: +pitrou
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
Well, actually I do have an idea. When 3.3 comes out, I think docs.python.org should point to that, and another url should point to the most recent 2.7.x release. The url for all versions is already stable. Then the sidebar could have entries for most recent 3.x and 2.x releases (without specifying) and other versions.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
My specific suggestion is that the sidebar be time-independent (for at least a decade, until Python 4 ;-) and say
Docs for other versions Current Python 3 Current Python 2 In development Everything else
with stable links for each.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Georg Brandl georg@python.org added the comment:
Sounds good.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
To make my idea work both now and after we switch docs.python.org, that url should not be used as either of the first two links. Rather there should be a docs.python.org/py2k (or whatever) that is the permanent 'latest Python 2 release' docs link.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Terry J. Reedy tjreedy@udel.edu added the comment:
'All Releases' rather than 'Everything else' is both more accurate and to me, more graceful.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue13122 _______________________________________
Irit Katriel iritkatriel@yahoo.com added the comment:
This is still unresolved. For instance, this says 3.7 is in development: https://docs.python.org/release/3.6.2/
---------- nosy: +iritkatriel versions: +Python 3.10, Python 3.8, Python 3.9 -Python 3.1, Python 3.2
_______________________________________ Python tracker report@bugs.python.org https://bugs.python.org/issue13122 _______________________________________
participants (8)
-
Antoine Pitrou -
Ezio Melotti
-
Georg Brandl
-
Irit Katriel
-
Ned Deily
-
Sandro Tosi
-
Sven Marnach
-
Terry J. Reedy