Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Github Actions to auto-generate user guide HTML #3454

Merged
merged 2 commits into from
May 5, 2020

Conversation

ferdnyc
Copy link
Contributor

@ferdnyc ferdnyc commented May 5, 2020

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 the requirements.txt file added to doc/ 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.

ferdnyc added 2 commits May 5, 2020 07:54
Certain environments (e.g. Sphinx doc builds in CI tasks) may
import classes.info but not have PyQt5 available.
@ferdnyc ferdnyc added the docs Bad or missing help texts / documentation label May 5, 2020
@ferdnyc
Copy link
Contributor Author

ferdnyc commented May 5, 2020

We're running the docs build at the end of each Travis run right now,

Actually, I take it back, I guess we're not doing that! Well, even better then.

@ferdnyc
Copy link
Contributor Author

ferdnyc commented May 5, 2020

Merging as this is primarily new configs, and the classes.info change just wraps a try: block around part of the code.

@ferdnyc ferdnyc merged commit 7465dcb into OpenShot:develop May 5, 2020
@ferdnyc ferdnyc deleted the sphinx-build-action branch May 5, 2020 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Bad or missing help texts / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant