Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding additional level of bookmarks and section numbers in python pdf documents. #53302

Closed
pengyuut mannequin opened this issue Jun 22, 2010 · 6 comments
Closed

Adding additional level of bookmarks and section numbers in python pdf documents. #53302

pengyuut mannequin opened this issue Jun 22, 2010 · 6 comments
Labels
3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@pengyuut
Copy link
Mannequin

pengyuut mannequin commented Jun 22, 2010

BPO 9056
Nosy @freddrake, @birkenfeld, @orsenthil, @ezio-melotti, @sandrotosi, @JulienPalard, @csabella
PRs
  • bpo-9056: Include subsections in TOC for PDF version of docs. #9629
    		•

    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 = None
closed_at = <Date 2020-02-18.23:04:21.131>
created_at = <Date 2010-06-22.03:00:34.682>
labels = ['type-feature', '3.8', 'docs']
title = 'Adding additional level of bookmarks and section numbers in python pdf documents.'
updated_at = <Date 2020-02-18.23:04:21.130>
user = 'https://bugs.python.org/pengyuut'

    bugs.python.org fields:

    activity = <Date 2020-02-18.23:04:21.130>
actor = 'mdk'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-02-18.23:04:21.131>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2010-06-22.03:00:34.682>
creator = 'pengyu.ut'
dependencies = []
files = []
hgrepos = []
issue_num = 9056
keywords = ['patch']
message_count = 6.0
messages = ['108334', '108370', '108374', '108382', '132033', '362237']
nosy_count = 9.0
nosy_names = ['fdrake', 'georg.brandl', 'orsenthil', 'ezio.melotti', 'pengyu.ut', 'sandro.tosi', 'docs@python', 'mdk', 'cheryl.sabella']
pr_nums = ['9629']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue9056'
versions = ['Python 3.8']
    @pengyuut
    Copy link
    Mannequin Author

    pengyuut mannequin commented Jun 22, 2010

    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

    @pengyuut pengyuut mannequin assigned docspython Jun 22, 2010
    @pengyuut pengyuut mannequin added the docs Documentation in the Doc dir label Jun 22, 2010
    @orsenthil
    Copy link
    Member

    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.

    @pengyuut
    Copy link
    Mannequin Author

    pengyuut mannequin commented Jun 22, 2010

    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.

    @freddrake
    Copy link
    Member

    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

    @sandrotosi
    Copy link
    Contributor

    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?

    @ezio-melotti ezio-melotti added the type-feature A feature request or enhancement label Feb 24, 2012
    @csabella csabella added the 3.8 only security fixes label Nov 15, 2018
    @JulienPalard
    Copy link
    Member

    Merged Cheryl's patch (thanks Cheryl!).

    pengyu.ut if you want to test it you'll be able to see generated PDF in a maximum of 24h from now on 1.

    Don't hesitate to ask if you need them for 3.8 we can backport it.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.8 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    6 participants
    @JulienPalard @orsenthil @sandrotosi @freddrake @csabella @ezio-melotti