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

ePUB output doesn't have table of contents #8362

Open
1 of 4 tasks
agjohnson opened this issue Jul 22, 2021 · 0 comments
Open
1 of 4 tasks

ePUB output doesn't have table of contents #8362

agjohnson opened this issue Jul 22, 2021 · 0 comments
Labels
Accepted Accepted issue on our roadmap Bug A bug

Comments

@agjohnson
Copy link
Contributor

It seems our docs do not generate an epub file with a table of contents. I opened our docs.readthedocs.io epub and noticed the table of contents was missing in both calibre and foliate:

image

The underlying issue is the build/epub/toc.ncx is mostly empty.

This definitely makes the format very hard to navigate. I'm sure other projects are hitting this as well, so probably worth investigating. This could be anything from just our docs, to our sphinx theme, any of our extensions, or even sphinx.

  • Perhaps an issue with the Sphinx theme?
    • I built an epub on the sphinx theme docs and it did have a table of contents
    • I built an epub on our docs with 'basic' theme and epub_theme="epub", and it still had an empty toc.ncx
    • Our theme is likely not affecting things then
  • One of our extensions?
    • We have some extensions that manipulate the docs a good deal, it's not unlikely that we wrote an extension that is interfering with epub
    • I disabled with extensions = [] and didn't notice a change, but this probably needs more testing.
  • Something about our doc project?
  • Sphinx?
@agjohnson agjohnson added Bug A bug Accepted Accepted issue on our roadmap labels Jul 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Bug A bug
Projects
None yet
Development

No branches or pull requests

1 participant