wrong page index number in reference book of python documentation

[ray]

BPO	4027
Nosy	@birkenfeld, @terryjreedy
Files	ref.png: reference document distutils.png: TOC for distutils.pdf (Python 2.6) typescript: make [pdf] \tableofcontents error

^{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 = 'https://github.com/birkenfeld'
closed_at = <Date 2008-10-17.11:25:23.488>
created_at = <Date 2008-10-03.09:41:15.412>
labels = ['type-bug', 'docs']
title = 'wrong page index number in reference book of python documentation'
updated_at = <Date 2008-10-19.08:19:37.065>
user = 'https://bugs.python.org/ray'

bugs.python.org fields:

activity = <Date 2008-10-19.08:19:37.065>
actor = 'wplappert'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-10-17.11:25:23.488>
closer = 'georg.brandl'
components = ['Documentation tools (Sphinx)']
creation = <Date 2008-10-03.09:41:15.412>
creator = 'ray'
dependencies = []
files = ['11689', '11701', '11815']
hgrepos = []
issue_num = 4027
keywords = []
message_count = 19.0
messages = ['74233', '74293', '74302', '74307', '74308', '74797', '74808', '74826', '74828', '74830', '74831', '74858', '74897', '74901', '74908', '74911', '74950', '74955', '74967']
nosy_count = 4.0
nosy_names = ['georg.brandl', 'terry.reedy', 'wplappert', 'ray']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue4027'
versions = ['Python 2.6', 'Python 3.0']

[ray]

the Glossary's index number is 3, which should be 75,
so people could not navigate "Glossary" by clicking the title showed in
Table of Content, or index link which is beside the content in Evince.

[terryjreedy]

Which version of the Ref Manual is this supposed to be?
By Evince do you mean the Gnome document viewer?
http://www.gnome.org/projects/evince/
If so, are you trying to view a .pdf downloaded from python.org?
If so, did you try viewing it with acrobat or some other .pdf viewer?
This would indicate whether the fault is with the Evince or Python's
.pdf generation or index support.

The screenshot shows two other major problems with the TOC.
Data model should not be indented; it is not part of lexical analysis.
Three chapters between Data Model and Compound Statements are missing.

[ray]

hi, sorry for didn't present very clear.

Which version of the Ref Manual is this supposed to be?

the newest python documentations, Release 2.6, October 2, 2008

By Evince do you mean the Gnome document viewer?
http://www.gnome.org/projects/evince/

Yes

If so, are you trying to view a .pdf downloaded from python.org?

Yes, from the official site. download the docs from
http://docs.python.org/ftp/python/doc/2.6/python-docs-pdf-a4.tar.bz2

If so, did you try viewing it with acrobat or some other .pdf viewer?

Yes, the same. I tested in acrobat. both has this problem.

This would indicate whether the fault is with the Evince or Python's
.pdf generation or index support.

I guess the problem is index support.

The screenshot shows two other major problems with the TOC.
Data model should not be indented; it is not part of lexical analysis.
Three chapters between Data Model and Compound Statements are missing.

exactly, the index may be messed up.

[wplappert]

In addition to the same issue: library.pdf, downloaded from
http://docs.python.org/ftp/python/doc/2.6/python-docs-pdf-a4.tar.bz2:

Glossary points to chapter 1,
"About these documents" chapter 2,
History and License chapter 3,
Copyright chapter 4.

The Index points correctly to the "Symbol Index", but misplaces the
"Module Index": the "Module Index" is a subchapter of the "Copyright".

[wplappert]

distutils.pdf shows the wrong behaviour quite nicely. See attached png file

[ray]

any feedback here?

[terryjreedy]

We are all volunteers here, and I see three replies.
This may or may not be trivial to fix, and may take some time.

Python docs are written in rst format and translated by Sphinx to
various formats. The main translation is to html, as viewed on the
site. Translation to .pdf is indirect via translation to latex and then
from latex to .pdf. Since the .html index appears flawless, and since a
different .pdf has problems, I suspect that the .pdf index problem is in
one of the two translation steps. Hence the change of component.

In the meanwhile, either ignore the index or use the html version.

[ray]

We are all volunteers here, and I see three replies.
This may or may not be trivial to fix, and may take some time.

Python docs are written in rst format and translated by Sphinx to
various formats. The main translation is to html, as viewed on the
site. Translation to .pdf is indirect via translation to latex and then
from latex to .pdf. Since the .html index appears flawless, and since a
different .pdf has problems, I suspect that the .pdf index problem is in
one of the two translation steps. Hence the change of component.

In the meanwhile, either ignore the index or use the html version.

Thanks a lot for you reply. I just intend to raise somebody's attention
to this
problem in order to improve reader's experience.

It might or might not be a trivial to fix though.

[wplappert]

This problem also applies to Python 3.0rc1.

Georg, could you please comment on ray's and tjreedy's question. Thanks

[birkenfeld]

I'm not ignoring this issue; I think it's a trivial fix once I find out
where :)

[ray]

ah, thanks goodness, what a fortune that you are not ignoring this problem.
I expect the fix could be happen in the near future. :)

[birkenfeld]

OK, I have the problem. The hyperref package must not be included before
fncychap, in fact, it should be included last.

I'll fix this as soon as I've found the most adaptable way to do it. :)

[ray]

Woohoo, you are awesome, thanks a lot!

[birkenfeld]

Should be fixed now in r66955. Thanks for your patience!

[wplappert]

Hi Georg,
I tried to rebuilt the documentation from scratch (2.6 as well as
3.0rc1) and make fails with the command " \tableofcontents", which is
part of the generated *.tex file. I will include the typescript output
of the make command. The error message in 'typescript' is line 77. The
checked ot revision of sphinx is: 'Checked out revision 66957.'

[wplappert]

Interesting: I reran the build of PDFs under Windows (XP) and it works
like a charm! Everything is there, the TOC, the Index and the Contents.
I have no idea why Ubuntus pdflatex decided to go on strike. Thanks a
lot for all your work!

[ray]

Thanks for your big efforts!

[birkenfeld]

Winfried, can you try again with the newest trunk?

[wplappert]

Georg,
sphinx r66972 works perfectly. Thanks again!