the table of contents in epub file is too long

[wrobell]

BPO	13282
Nosy	@birkenfeld, @ezio-melotti, @merwok, @willingc, @JulienPalard, @jcrben

^{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 = None
created_at = <Date 2011-10-28.10:08:26.173>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'the table of contents in epub file is too long'
updated_at = <Date 2019-04-11.07:05:55.502>
user = 'https://bugs.python.org/wrobell'

bugs.python.org fields:

activity = <Date 2019-04-11.07:05:55.502>
actor = 'jcrben'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2011-10-28.10:08:26.173>
creator = 'wrobell'
dependencies = []
files = []
hgrepos = []
issue_num = 13282
keywords = []
message_count = 3.0
messages = ['146548', '147477', '339931']
nosy_count = 8.0
nosy_names = ['georg.brandl', 'wrobell', 'ezio.melotti', 'eric.araujo', 'docs@python', 'willingc', 'mdk', 'jcrben']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue13282'
versions = ['Python 3.7', 'Python 3.8']

Linked PRs

• gh-57491: Reduce the EPUB table of contents depth to 2 #158105
• [3.15] gh-57491: Reduce the EPUB table of contents depth to 2 (GH-158105) #158249
• [3.14] gh-57491: Reduce the EPUB table of contents depth to 2 (GH-158105) #158250
• [3.13] gh-57491: Reduce the EPUB table of contents depth to 2 (GH-158105) #158251

[wrobell]

the table of contents in python documentation epub file is very very long. it takes several long minutes to jump from first page to a part containing language reference toc.

imho it would be great if first page of epub file contained pointers
to tutorial, lang ref, mod ref without detailed table of contents as it is at docs.python.org.

[merwok]

Thanks for the report. I do not know if this something that we can fix in the CPython repository by editing some template or config file or if it requires a patch to Sphinx first. Georg?

[jcrben]

Not sure if this is filed elsewhere, but the contents on the page at https://docs.python.org/3/contents.html could really use a collapse button, and could start automatically collapsed. The first half of the page is "What's new" for the past few Python versions and the Changelog.

I looked around for an issue in the upstream tracker and didn't see one https://github.com/sphinx-doc/sphinx/issues - I don't know much about Sphinx but it seems like it should be possible with a bit of Javascript and CSS.

[m-aciek]

I think we should decrease table of content depth to 2 (or 1?) for EPUBs. There's a setting for that in Sphinx.

[willingc]

Great suggestion @m-aciek. Thanks for pointing out the config setting. I wasn't aware it existed.