Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.4k
gh-136155: Docs: check for EPUB fatal errors in CI#134074
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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.
Thanks for the PR!
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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.
Thanks, looks good.
We'll need to wait for#136155 (comment) /sphinx-doc/sphinxext-opengraph#136 /sphinx-doc/sphinxext-opengraph#137 to be fixed before merging.
But they're taking some time. Until sphinxext-opengraph is fixed and released, is it useful to log these errors in CI,without failing? Or shall we wait a bit longer?
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Would it be worth to add |
As a custom file? Probably not, because it would only be for the short term. Unlike |
I modified the PR for the case it would be useful. PS on a shelf I have a changeset to print also regular errors informationally, but I think I will wait with it until fatal errors are gone. EPUB build on my machine produces 92 errors currently and I don't want to make fatal errors to be drown out by them in the logs. |
@@ -66,7 +66,7 @@ jobs: | |||
run:| | |||
set -Eeuo pipefail | |||
# Build docs with the nit-picky option; write warnings to file | |||
make -C Doc/ PYTHON=../python SPHINXOPTS="--quiet --nitpicky --fail-on-warning --warning-file sphinx-warnings.txt" html | |||
make -C Doc/ PYTHON=../python SPHINXOPTS="--quiet --nitpicky --warning-file sphinx-warnings.txt" html |
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
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
624bf52
intopython:mainUh oh!
There was an error while loading.Please reload this page.
Thank you! |
Uh oh!
There was an error while loading.Please reload this page.
Validate EPUB documentation for not having warnings with level
FATAL
when runningEPUBCheck 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.