ci: fail Sphinx doc builds on warnings and deploy on successful merge to main #6
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
- Updated workflow to use `sphinx-build -W` to treat warnings as errors - Blocks PR merges if doc build fails due to warnings - On successful merge to `main`,rebuilds and deploys docs to GitHub Pages It's based on work by @jimmac
panyamkeerthana
force-pushed
the
panyamkeerthana/CI_error_detection
branch
from
f29265f to
5389e76
Compare
changed workflow title (test)
changes to workflow action names test2
Contributor
|
I'm no expert but reading over the workflow it looks like it does what's needed. Thanks! |
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.
sphinx-build -Wto treat warnings as errorsmain, rebuilds and deploys docs to GitHub Pagesbased on the work of @jimmac 🙌
closes #2