gh-136155: Docs: check for EPUB fatal errors in CI #134074
Conversation
| @@ -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
There was a problem hiding this comment.
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?
| @@ -75,6 +75,17 @@ jobs: | |||
| --fail-if-regression \ | |||
| --fail-if-improved \ | |||
| --fail-if-new-news-nit | |||
| - name: 'Build EPUB documentation and load EPUB checks to file' | |||
There was a problem hiding this comment.
| - name: 'Build EPUB documentation and load EPUB checks to file' | |
| - name: 'Build EPUB documentation' |
| 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' |
There was a problem hiding this comment.
| - name: 'Check for FATAL errors in EPUB' | |
| - name: 'Check for fatal errors in EPUB' |
|
Would it be worth to add |
|
As a custom file? Probably not, because it would only be for the short term. Unlike |
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.