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: next/previous links in documentation skip some sections
Type: Stage:
Components: Documentation Versions: Python 3.1, Python 3.2, Python 2.7, Python 2.6
process
Status: closed Resolution: works for me
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: ezio.melotti, georg.brandl, ggenellina
Priority: normal Keywords:

Created on 2010-01-05 00:19 by ggenellina, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (3)
msg97239 - (view) Author: Gabriel Genellina (ggenellina) Date: 2010-01-05 00:19
The next/previous links in the documentation skip some sections. This happens both in HTML format and the CHM Windows help file.

e.g.: in the Library Reference, section "8.5 StringIO" [next] points to "8.7 textwrap", skipping section "8.6 cStringIO". And section "9.12 UserDict" [next] points to "9.15 Types", skipping sections 9.13 and 9.14 (UserList and UserString). Same with their reverse links: 9.15 [previous] points to 9.12.

It seems those links connect *files*, not *sections*, and such logic fails when a single file contains more than a section. From a user POV that's not the expected behavior: the next/previous links should navigate the complete document, regardless of its physical implementation (the actual .rst files).

(In that case this might be a Sphinx bug rather than a Python one)
msg97253 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2010-01-05 07:44
I think the purpose of the 'next' and 'previous' is to move to the next/previous page (i.e. file) and not another section in the same page. If you read a page till the end and then you press 'next' you probably want to go to the next page, not to next section that is in the middle of the page that you just read.
I agree that sometimes it looks weird though, especially in the index.
The only thing that IMHO could be "fixed" is limiting the number of sections in a page to 1, otherwise I'd just close this as "won't fix".
msg97256 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2010-01-05 10:09
Ezio is right.  The "next" links are meant to take you to the next logical file, and if one file contains multiple top-level sections, that is going to be several chapters away.
History
Date User Action Args
2022-04-11 14:56:56adminsetgithub: 51883
2010-01-05 10:09:56georg.brandlsetstatus: pending -> closed
resolution: works for me
messages: + msg97256
2010-01-05 07:44:07ezio.melottisetstatus: open -> pending
priority: normal

nosy: + ezio.melotti
messages: + msg97253
2010-01-05 00:19:49ggenellinacreate