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: Global Module Index link in the offline documentation is incorrect
Type: Stage:
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution: not a bug
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, ezio.melotti, georg.brandl, graemeglass
Priority: normal Keywords:

Created on 2011-10-10 12:16 by graemeglass, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (3)
msg145295 - (view) Author: Graeme Glass (graemeglass) Date: 2011-10-10 12:16
On my machine (Ubuntu 11.04) the link to "Python Module Index" from the index page is incorrect in the "Indices and tables" section (it links to    
modindex.html instead of py-modindex.html).
It links to the correct place in the navigation bar at the top right of the page.

Navigation (Correct): 
<li class="right" >
    <a href="py-modindex.html" title="Python Module Index">modules</a> 
|</li>

In the body (Incorrect):
 <p><strong>Indices and tables:</strong></p>
  ...
  <p class="biglink"><a class="biglink" href="modindex.html">Global Module Index</a><br/
  ...

This seems to affect python2.6 and python2.7 documentation.

(Indices and tables) link for these files:
file:///usr/share/doc/python2.6/html/index.html
file:///usr/share/doc/python2.6-doc/html/index.html

Link to: 
file:///usr/share/doc/python2.6/html/modindex.html
file:///usr/share/doc/python2.6-doc/html/modindex.html

When they should link to:
file:///usr/share/doc/python2.6/html/py-modindex.html
file:///usr/share/doc/python2.6-doc/html/py-modindex.html

Likewise:
file:///usr/share/doc/python2.7/html/index.html
file:///usr/share/doc/python2.7-doc/html/index.html

Link to:
file:///usr/share/doc/python2.7/html/modindex.html
file:///usr/share/doc/python2.7-doc/html/modindex.html

When they should link to:
file:///usr/share/doc/python2.7/html/py-modindex.html
file:///usr/share/doc/python2.7-doc/html/py-modindex.html

I searched the python bug tracker for a similar issue and could not find one.
I do not know if this affects python3.x Documentation also as I do not have it installed so have not checked. 
I am not sure if this is an Ubuntu issue or Python Docs Issue.
msg145720 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2011-10-17 15:58
Can you clone the repository, build the doc with “make html” as explained in http://docs.python.org/documenting/building and tell us if the bug is there?  If not, it’s specific to Debian or Ubuntu.
msg145753 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2011-10-17 18:45
2.x docs are supposed to be built with Sphinx 0.6.x -- there the link is correct.

If Ubuntu chooses to ignore this and build with 1.0.x, they will have to include a patch fixing the link.
History
Date User Action Args
2022-04-11 14:57:22adminsetgithub: 57353
2011-10-17 18:45:16georg.brandlsetstatus: open -> closed

nosy: + georg.brandl
messages: + msg145753

resolution: not a bug
2011-10-17 15:58:40eric.araujosetnosy: + eric.araujo
messages: + msg145720
2011-10-14 23:40:41ezio.melottisetnosy: + ezio.melotti

versions: - Python 2.6
2011-10-10 12:16:08graemeglasscreate