Add GitHub Action for testing documentation build during pull requests #207
Conversation
This file contains 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
|
This problem was raised by #202, where merging a new PR led to a new version of jinja2 being used for building the documentation. This was not caught by our build tests of the PR, and was only realized when the site build failed. |
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.
This PR adds a GitHub Action workflow that builds the static documentation site using sphinx. This addresses a lingering issue that the documentation build is only attempted upon merging into the
mainbranch. This way we can catch issues before merging.This workflow is equivalent to the documentation build, but any changes are not added to the
gh-pagesbranch and the site itself is not updated.