first draft PR docs build workflow #1042
Draft
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 workflow that allows for building documentation in PRs. We already have publishing with RTD for releases (tags) and pushes to
main
, and we have a CI job that runsdoctest
(which implicitly also ensures that docs are valid since they need to be built).This workflow is a little different. On a PR, it builds the HTML docsite for both the PR contents and for the target branch (for example
main
), and then diffs them. If there are any changes, it:This workflow uses the
pull_request_target
trigger which has a few caveats and things to know:main
), so the workflow that gets executed is never from the PR itself (this is a necessary security decision)