Detect doc build failure - #10
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation build workflow to run on pull requests (so doc build failures are caught earlier) and tightens the docs to avoid formatting/warning issues during Sphinx builds.
Changes:
- Run the documentation build workflow on
pull_requestevents targetingmaster. - Treat Sphinx warnings as errors (intended via
-W) and prevent Pages deployment on non-pushevents. - Minor reStructuredText table formatting/whitespace cleanup in the docs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
doc/source/input_file.rst |
Adjusts table formatting/whitespace in docs (likely to keep Sphinx output clean). |
.github/workflows/astra-ci-doc.yml |
Adds PR trigger and deploy gating; attempts to enforce “warnings as errors” for doc builds. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
No description provided.