Use Github Actions to auto-generate user guide HTML #3454
Merged
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.
We're running the docs build at the end of each Travis run right now, which is fine for CI purposes, but not very convenient.
Using Github Actions, instead, lets the results of the run be exported as an Artifact from the job, so that the generated HTML tree can be downloaded as a ZIP file right from the Actions status page. Handy for documentation contributors, so they don't have to go through the hassle of setting up to run Sphinx on their own PCs.
A tweak to
src/classes/info.py
makes it handle PyQt5 being unavailable (as it will be, in the Actions environment), and therequirements.txt
file added todoc/
is a standard config defining the Python module dependencies for our Sphinx config. The Actions task will ensure that all dependencies are met before starting the build.