gh-136155: Docs: check for EPUB fatal errors in CI #134074
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -517,6 +517,7 @@ | |
|
|
||
| epub_author = 'Python Documentation Authors' | ||
| epub_publisher = 'Python Software Foundation' | ||
| epub_exclude_files = ('index.xhtml', 'download.xhtml') | ||
|
There was a problem hiding this comment. For reference:
|
||
|
|
||
| # index pages are not valid xhtml | ||
| # https://github.com/sphinx-doc/sphinx/issues/12359 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import sys | ||
| from pathlib import Path | ||
|
|
||
|
|
||
| def main() -> int: | ||
| wrong_directory_msg = "Must run this script from the repo root" | ||
| if not Path("Doc").exists() or not Path("Doc").is_dir(): | ||
| raise RuntimeError(wrong_directory_msg) | ||
|
|
||
| with Path("Doc/epubcheck.txt").open(encoding="UTF-8") as f: | ||
| messages = [message.split(" - ") for message in f.read().splitlines()] | ||
|
|
||
| fatal_errors = [message for message in messages if message[0] == "FATAL"] | ||
|
|
||
| if fatal_errors: | ||
| print("\nError: must not contain fatal errors:\n") | ||
| for error in fatal_errors: | ||
| print(" - ".join(error)) | ||
|
|
||
| return len(fatal_errors) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| sys.exit(main()) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| We are now checking for fatal errors in EPUB builds in CI. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The redundancy can be seen in a job logs (from before the change): https://github.com/python/cpython/actions/runs/16254225968/job/45888071303