[Django] #23485: Add deeper bookmarks to Django Docs PDF
Django
-------------------------------+-------------------------------------
Reporter: kutenai | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords: pdf epub Docs bookmarks
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+-------------------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/23485>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: kutenai | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Accepted
Keywords: pdf epub Docs | Needs documentation: 0
bookmarks | Patch needs improvement: 0
Has patch: 0 | UI/UX: 0
Needs tests: 0 |
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Changes (by timgraham):
* needs_better_patch: => 0
* needs_tests: => 0
* easy: 1 => 0
* needs_docs: => 0
* type: Uncategorized => Cleanup/optimization
* stage: Unreviewed => Accepted
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/23485#comment:1>
Django
Reporter: kutenai | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: pdf epub Docs | Triage Stage: Accepted
bookmarks |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by adamzap):
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/23485#comment:2>
Django
Reporter: kutenai | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: pdf epub Docs | Triage Stage: Accepted
bookmarks |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* Attachment "Screen Shot 2015-04-11 at 12.48.35 PM.png" added.
Django
Reporter: kutenai | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: pdf epub Docs | Triage Stage: Accepted
bookmarks |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by adamzap):
* Attachment "Screen Shot 2015-04-11 at 12.49.47 PM.png" added.
Django
Reporter: kutenai | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: pdf epub Docs | Triage Stage: Accepted
bookmarks |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by timgraham):
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/23485#comment:3>
Django
Reporter: kutenai | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: pdf epub Docs | Triage Stage: Accepted
bookmarks |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by kutenai):
I'm not going to be able to submit a patch for this, not with my current
workload. I would agree with closing it.
--
Ticket URL: <https://code.djangoproject.com/ticket/23485#comment:4>
Django
Reporter: kutenai | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: master
Severity: Normal | Resolution: wontfix
Keywords: pdf epub Docs | Triage Stage: Accepted
bookmarks |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => wontfix
--
Ticket URL: <https://code.djangoproject.com/ticket/23485#comment:5>