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

gh-118689: fix ePub build #118690

Merged
merged 2 commits into from
May 10, 2024
Merged

gh-118689: fix ePub build #118690

merged 2 commits into from
May 10, 2024

Conversation

methane
Copy link
Member

@methane methane commented May 7, 2024

@methane
Copy link
Member Author

methane commented May 7, 2024

glossary.json caused unknown mimetype error. I don't know when this error starts. Maybe, recent Sphinx become more strict?

#116966 introduced JavaScript in ePub. This should be backported into 3.12.

#109438 introduced duplicated ToC error. This is Python 3.13 only issue.

@methane
Copy link
Member Author

methane commented May 7, 2024

With this fix, I can open the epub file with Books.app in macOS.

There are many other errors reported by epubcheck.
Some of them are caused by opengraph.
wpilibsuite/sphinxext-opengraph#120

@methane methane added type-bug An unexpected behavior, bug, or error docs Documentation in the Doc dir 3.12 bugs and security fixes needs backport to 3.12 bug and security fixes labels May 7, 2024
@methane
Copy link
Member Author

methane commented May 7, 2024

Another issue:
readthedocs/sphinx-notfound-page#230

@methane
Copy link
Member Author

methane commented May 7, 2024

Remaining errors:

$ epubcheck --locale en-US build/epub/Python.epub 2>python-epub-errors.txt

https://gist.github.com/methane/03a569934bec14a2b4b2a783f96d01b3

@methane
Copy link
Member Author

methane commented May 7, 2024

I found epub_use_index option so I use it to disable index.
Index page has been broken from start. When I show index page in Books.app, the app show only erro and I can not use the book.
Since index pages are very inaccessible (no link from toc), no one care it.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the fixes.

With this fix, I can open the epub file with Books.app in macOS.

Same here 👍

There are many other errors reported by epubcheck.

This sounds like something we should aim to add to the CI, even if we start with a subset of passing checks.

Thanks also for opening issues in the extensions.

@serhiy-storchaka serhiy-storchaka added the needs backport to 3.13 bugs and security fixes label May 9, 2024
@methane methane merged commit 7ac933e into python:main May 10, 2024
28 checks passed
@methane methane deleted the fix-epub branch May 10, 2024 10:24
@miss-islington-app
Copy link

Thanks @methane for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 10, 2024
(cherry picked from commit 7ac933e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 10, 2024
(cherry picked from commit 7ac933e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented May 10, 2024

GH-118889 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label May 10, 2024
@bedevere-app
Copy link

bedevere-app bot commented May 10, 2024

GH-118890 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label May 10, 2024
methane added a commit that referenced this pull request May 10, 2024
(cherry picked from commit 7ac933e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
methane added a commit that referenced this pull request May 10, 2024
(cherry picked from commit 7ac933e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.12 bugs and security fixes docs Documentation in the Doc dir skip news type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants