Skip to content
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

Jump to bottom

Report Sphinx build warnings in CI #2402

Closed
stefan6419846 opened this issue Jan 9, 2024 · 0 comments · Fixed by #2405
Closed

Report Sphinx build warnings in CI #2402

stefan6419846 opened this issue Jan 9, 2024 · 0 comments · Fixed by #2405

Comments

@stefan6419846
Copy link
Collaborator

Sphinx build warnings in CI currently remain unnoticed.

We should have a look at how we can integrate them into CI and let warnings/violations fail the corresponding workflow to avoid having to re-check manually each time.
@stefan6419846 stefan6419846 mentioned this issue Jan 11, 2024
Merged
MartinThoma pushed a commit that referenced this issue Jan 17, 2024
@stefan6419846
DEV: Fail on Sphinx issues (#2405)
23a5a49 
This adds a code style check to avoid unexpectedly shipping docs/docstrings which cause issues.

Options (the long names are only part of the upcoming 7.3 release), based upon https://www.sphinx-doc.org/en/master/man/sphinx-build.html:

  * `-n`: Report warnings for missing references.
  * `-W`: Turn warnings into errors and stop at first violation.
  * `--keep-going`: Improve `-W` by collecting all violations and only failing at the end.
  * `-T`: Display the full traceback on actual errors.
  * `-b html`: Build HTML pages.
  * `docs`: Source directory.
  * `build/sphinx/html`: Target directory.
 
Fixes #2402
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DEV: Fail on Sphinx issues stefan6419846/pypdf
1 participant
@stefan6419846