Opened 10 years ago

Closed 8 years ago

#23485 closed Cleanup/optimization (wontfix)

Add deeper bookmarks to Django Docs PDF

Reported by: Ed Henderson Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: pdf epub Docs bookmarks
Cc: kutenai@… Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The django docs pdf output includes only a couple of levels of bookmarks. There are some very large sections that could really use more bookmark levels. This would make the PDF far more useable, as well as the epub.

I assume that the PDF is generated, so would it be possible to increase the depth of bookmarks.

I would suggest:

  • Bookmarks include the section heading, i.e. "6.5 contrib packages"
  • Bookmarks include the additional level below 6.5, i.e. 6.5.x for all sections.

Item 1 would be 'nice to have' item 2, would be very helpful**

If possible, I'd like to see 1 level of bookmarks below the 6.5.x level, as some of those sections can be quite large, and sub-headings would be great as well.

Attachments (2)

Screen Shot 2015-04-11 at 12.48.35 PM.png (203.1 KB ) - added by Adam Zapletal 9 years ago.
Screen Shot 2015-04-11 at 12.49.47 PM.png (159.9 KB ) - added by Adam Zapletal 9 years ago.

Download all attachments as: .zip

Change History (7)

comment:1 by Tim Graham, 10 years ago

Easy pickings: unset
Triage Stage: UnreviewedAccepted
Type: UncategorizedCleanup/optimization

Not sure if it's possible, but we can look into it. Not sure about including all the 3rd level headings as there are a lot of them.

comment:2 by Adam Zapletal, 9 years ago

The PDF docs already include the section header in ToC/Bookmarks. See my attached screenshots of both Preview on Mac OS X and PDFOnlineReader. Maybe I'm misunderstanding the question?

Regarding the second point of this ticket, this SO thread may help:

http://stackoverflow.com/questions/20073309/how-to-set-sphinx-and-latexpdf-toc-depth

There's also an epub_tocdepth setting in docs/conf.py.

by Adam Zapletal, 9 years ago

by Adam Zapletal, 9 years ago

comment:3 by Tim Graham, 8 years ago

Feel free to offer a patch if you feel additional headings would help in either context. I'm not opposed to closing this ticket as wontfix if it doesn't make sense.

comment:4 by Ed Henderson, 8 years ago

I'm not going to be able to submit a patch for this, not with my current workload. I would agree with closing it.

comment:5 by Ed Henderson, 8 years ago

Resolution: wontfix
Status: newclosed
Note: See TracTickets for help on using tickets.
Back to Top