Skip to content

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Jul 15, 2025
Merged

gh-136155: Docs: check for EPUB fatal errors in CI #134074

Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
3837b1b
Build and check EPUB documentation
m-aciek May 15, 2025
276437b
Specify the epub filename
m-aciek May 15, 2025
50cf4cb
Fix filepath
m-aciek May 15, 2025
870bcea
Add simple EPUB fatals check
m-aciek Jul 1, 2025
be7e6f6
Fix CI
m-aciek Jul 1, 2025
2d8b0ce
Exclude index and download page from EPUB build (they are not used)
m-aciek Jul 1, 2025
733e2c9
📜🤖 Added by blurb_it.
blurb-it[bot] Jul 1, 2025
4395f5d
Remove superfluous flag in SPHINXOPTS, shorten step name
m-aciek Jul 1, 2025
f2cd73c
Merge branch 'main' into ci-epubcheck
m-aciek Jul 7, 2025
418ad4d
Annotate type of main function, refactor for mypy, rename fatal_warni…
m-aciek Jul 9, 2025
b545811
Merge EPUB check into build-doc job
m-aciek Jul 9, 2025
02a7bcf
Update names of steps
m-aciek Jul 13, 2025
01ba3c6
Temporarily don't fail on EPUB check fatal errors
m-aciek Jul 13, 2025
ea3ed7c
Wording simplification
m-aciek Jul 13, 2025
b9c43d7
Rename fatal_errors variable
m-aciek Jul 13, 2025
7b41b5e
Rename variable used in interation
m-aciek Jul 13, 2025
1f58864
Remove superfluous variable
m-aciek Jul 13, 2025
f043c2e
Wording simplification
m-aciek Jul 13, 2025
4573893
Revert "Wording simplification" -- it was another file commited by mi…
m-aciek Jul 13, 2025
f2e74c9
Remove redundant --fail-on-warning
m-aciek Jul 13, 2025
7a170c1
Revert literal in raised exception
m-aciek Jul 15, 2025
e5610bb
Rename helper variable to message
m-aciek Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove redundant --fail-on-warning
  • Loading branch information
@m-aciek
m-aciek committed Jul 13, 2025
commit f2e74c9059d97b105f09caed04712c174e635af3
2 changes: 1 addition & 1 deletion .github/workflows/reusable-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

@m-aciek m-aciek Jul 13, 2025 •
edited
Loading

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

- name: 'Check warnings'
if: github.event_name == 'pull_request'
run: |
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy