add basic Sphinx-build GitHub Action and accompanying status badge#7838
Merged
kcondon merged 1 commit intoIQSS:developfrom May 3, 2021
Merged
Conversation
scolapasta
approved these changes
May 3, 2021
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
4 participants
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.
What this PR does / why we need it: now that Sphinx is upgraded we can enable a basic, and currently free, GitHub Action to build the guides triggered by any pull request affecting
doc/sphinx-guides/source/. This is a first step to allow for Sphinx syntax linting, but further experimentation could push HTML builds to gdcc.io or possibly guides.dataverse.org.Which issue(s) this PR closes:
Closes #7837
Special notes for your reviewer: none
Suggestions on how to test this: once merged, should run automatically on the next PR against
doc/sphinx-guides/source/Does this PR introduce a user interface change? If mockups are available, please link/include them here: no
Is there a release notes update needed for this change?: no
Additional documentation: none