gh-136155: Docs: check for EPUB fatal errors in CI #134074
Open
+63
−0
Conversation
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
m-aciek
referenced
this pull request
in python/python-docs-pl
May 16, 2025
m-aciek
changed the title
hugovk
reviewed
Jul 7, 2025
| @@ -512,6 +512,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:
A sequence of files that are generated/copied in the build directory but should not be included in the EPUB file.
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-epub_exclude_files
| from pathlib import Path | ||
|
|
||
|
|
||
| def main(): |
There was a problem hiding this comment.
Suggested change
| def main(): | |
| def main() -> int: |
Comment on lines
+15
to
+22
| fatals = [warning for warning in warnings if warning[0] == "FATAL"] | ||
|
|
||
| if fatals: | ||
| print("\nError: must not contain fatal errors:\n") | ||
| for fatal in fatals: | ||
| print(" - ".join(fatal)) | ||
|
|
||
| return len(fatals) |
There was a problem hiding this comment.
Suggested change
| fatals = [warning for warning in warnings if warning[0] == "FATAL"] | |
| if fatals: | |
| print("\nError: must not contain fatal errors:\n") | |
| for fatal in fatals: | |
| print(" - ".join(fatal)) | |
| return len(fatals) | |
| fatal_warnings = [warning for warning in warnings if warning[0] == "FATAL"] | |
| if fatal_warnings: | |
| print("\nError: must not contain fatal errors:\n") | |
| for warning in fatal_warnings: | |
| print(" - ".join(warning)) | |
| return len(fatal_warnings) |
Comment on lines
+106
to
+107
| epubcheck: | ||
| name: 'EPUB check' |
There was a problem hiding this comment.
Suggested change
| epubcheck: | |
| name: 'EPUB check' | |
| check-epub: | |
| name: 'Check EPUB' |
Comment on lines
+129
to
+139
| - name: 'Build and load EPUB checks to file' | ||
| continue-on-error: true | ||
| run: | | ||
| set -Eeuo pipefail | ||
| make -C Doc/ PYTHON=../python SPHINXOPTS="--quiet" epub | ||
| pip install epubcheck | ||
| epubcheck Doc/build/epub/Python.epub &> Doc/epubcheck.txt | ||
| - name: 'Check for FATAL errors in EPUB' | ||
| if: github.event_name == 'pull_request' | ||
| run: | | ||
| python Doc/tools/check-epub.py |
There was a problem hiding this comment.
Rather than this new job, shall we add these two steps to the end of the existing build-doc job?
That can help prevent quite a bit of duplicate setup config.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Validate EPUB documentation for not having warnings with level
FATALwhen running EPUBCheck in the CI.This should prevent issues similar to #136155 in the future.
The check will pass after rebase on #136187 merged to the main branch.