classification
Title: Adding additional level of bookmarks and section numbers in python pdf documents.
Type: enhancement Stage: patch review
Components: Documentation Versions: Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: cheryl.sabella, docs@python, ezio.melotti, fdrake, georg.brandl, mdk, orsenthil, pengyu.ut, sandro.tosi
Priority: normal Keywords: patch

Created on 2010-06-22 03:00 by pengyu.ut, last changed 2018-11-15 22:05 by cheryl.sabella.

Pull Requests
URL Status Linked Edit
PR 9629 open cheryl.sabella, 2018-09-28 22:17
Messages (5)
msg108334 - (view) Author: (pengyu.ut) Date: 2010-06-22 03:00
Current pdf version of python documents don't have bookmarks for
sussubsection. For example, there is no bookmark for the following
section in python_2.6.5_reference.pdf. Also the bookmarks don't have
section numbers in them. I suggest to include the section numbers.
Could these features be added in future release of python document.

3.4.1 Basic customization
msg108370 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2010-06-22 11:25
You mean "Table of Contents"? The index at the end serves as a
bookmark, right?  Also, Table of Contents might add up couple of more
pages to traverse.
msg108374 - (view) Author: (pengyu.ut) Date: 2010-06-22 13:41
On Tue, Jun 22, 2010 at 6:25 AM, Senthil Kumaran <report@bugs.python.org> wrote:
>
> Senthil Kumaran <orsenthil@gmail.com> added the comment:
>
> You mean "Table of Contents"? The index at the end serves as a
> bookmark, right?  Also, Table of Contents might add up couple of more
> pages to traverse.

I don't need subsubsections to be in the table of content. But I think
it is making sense to add them in the bookmarks, as the bookmarks can
be folded even if there are many bookmarks for subsubsections. I'm not
refereeing to index.
msg108382 - (view) Author: Fred L. Drake, Jr. (fdrake) (Python committer) Date: 2010-06-22 14:17
On Mon, Jun 21, 2010 at 11:00 PM, pengyu.ut <report@bugs.python.org> wrote:
> Current pdf version of python documents don't have bookmarks for
> sussubsection. For example, there is no bookmark for the following
> section in python_2.6.5_reference.pdf.

This would be nice to have.

> Also the bookmarks don't have
> section numbers in them. I suggest to include the section numbers.

Hmm.  I'm not a huge fan of section numbers, but so long as we use them,
there's some rationale to include them in the PDF bookmarks.  So I guess
that's up to whoever creates the patch.

  -Fred
msg132033 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2011-03-24 21:27
The number of items in the bookmark is controlled by 

\setcounter{tocdepth}{1}

in sphinxmanual.cls, that's included in every latex file (the source of the PDF documentation). The cls file is coming directly from sphinx, so Georg: what is the purpose of limiting the bookmarks depth to 1? can we consider (somehow) to special-case if for python?
History
Date User Action Args
2018-11-15 22:05:13cheryl.sabellasetnosy: + mdk, cheryl.sabella

versions: + Python 3.8, - Python 3.3
2018-09-28 22:17:04cheryl.sabellasetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request9026
2012-02-24 11:07:56ezio.melottisettype: enhancement
stage: needs patch
2011-03-26 19:12:40ezio.melottisetnosy: + ezio.melotti
2011-03-24 21:27:30sandro.tosisetnosy: + georg.brandl, sandro.tosi

messages: + msg132033
versions: + Python 3.3, - Python 2.6
2010-06-22 14:17:18fdrakesetnosy: + fdrake
messages: + msg108382
2010-06-22 13:41:14pengyu.utsetmessages: + msg108374
2010-06-22 11:25:36orsenthilsetnosy: + orsenthil
messages: + msg108370
2010-06-22 03:00:34pengyu.utcreate