◐ Shell
reader mode source ↗
Skip to content

gh-118689: fix ePub build#118690

Merged
methane merged 2 commits into
python:mainfrom
methane:fix-epub
May 10, 2024
Merged

gh-118689: fix ePub build#118690
methane merged 2 commits into
python:mainfrom
methane:fix-epub

Conversation

@methane

@methane methane commented May 7, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

@bedevere-app bedevere-app Bot mentioned this pull request May 7, 2024
Closed
@methane

methane commented May 7, 2024 •
edited
Loading

Copy link
Copy Markdown
Member Author

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

methane commented May 7, 2024

Copy link
Copy Markdown
Member Author

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.
sphinx-doc/sphinxext-opengraph#120

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

methane commented May 7, 2024

Copy link
Copy Markdown
Member Author

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

@methane

methane commented May 7, 2024

Copy link
Copy Markdown
Member Author

Remaining errors:

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

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

@methane

methane commented May 7, 2024

Copy link
Copy Markdown
Member Author

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.

hugovk
hugovk approved these changes May 7, 2024
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hide comment

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
@methane methane deleted the fix-epub branch May 10, 2024 10:24
@miss-islington-app

miss-islington-app Bot commented May 10, 2024

Copy link
Copy Markdown

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
@methane @miss-islington
pythongh-118689: Doc: fix ePub build (pythonGH-118690) …
a516774 
(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
@methane @miss-islington
pythongh-118689: Doc: fix ePub build (pythonGH-118690) …
9a5c023 
(cherry picked from commit 7ac933e)

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

bedevere-app Bot commented May 10, 2024

Copy link
Copy Markdown

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

bedevere-app Bot commented May 10, 2024

Copy link
Copy Markdown

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 only security fixes label May 10, 2024
methane added a commit that referenced this pull request May 10, 2024
@miss-islington @methane
gh-118689: Doc: fix ePub build (GH-118690) …
9f8f14a 
(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
@miss-islington @methane
gh-118689: Doc: fix ePub build (GH-118690) …
760b3f0 
(cherry picked from commit 7ac933e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
@methane methane mentioned this pull request May 15, 2024
Closed
@JelleZijlstra JelleZijlstra mentioned this pull request May 28, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk approved these changes

Assignees

No one assigned

Labels

3.12 only security fixes docs skip news type-bug An unexpected behavior, bug, or error

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@methane @hugovk @serhiy-storchaka