Add CI test for building the website with sphinx - #25
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 new Github actions workflow "test website" that is run on PRs to main. It will run the sphinx-build process. This test should pass before merging to main.
Note that unlike the current "website" workflow this one does not try and deploy to github pages. The existing "website" workflow cannot deploy to gh-pages from a personal fork, this hides build errors in the sphinx docs, e.g. this PR failed to build the website: https://github.com/openmm/openmm-cookbook/actions/runs/4855480375
This PR also fixes the error from #18