Merge pull request #3454 from ferdnyc/sphinx-build-action

Use Github Actions to auto-generate user guide HTML

Author: ferdnyc

.github/workflows/sphinx.yml

@@ -0,0 +1,32 @@
+# Github Actions workflow to generate documentation
+# Uses the following shared task definitions:
+# - (checkout, upload artifact) from Github
+# - sphinx-action maintained by @ammaraskar
+name: Sphinx build
+
+# Controls when the action will run.
+# Triggers the workflow on push or pull request events.
+on:
+- push
+- pull_request
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps are a sequence of tasks that will be executed as part of the job
+    steps:
+    # Check out repository under $GITHUB_WORKSPACE
+    - uses: actions/checkout@v2
+    # Builds docs using sphinx
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "doc/"
+    # Create an artifact out of the generated HTML
+    - uses: actions/upload-artifact@v1
+      with:
+        name: UserGuideHTML
+        path: "doc/_build/html/"

doc/requirements.txt

@@ -0,0 +1,3 @@
+sphinx_rtd_theme
+sphinx_copybutton
+

src/classes/info.py

@@ -28,8 +28,6 @@
 import os
 from time import strftime
 
-from PyQt5.QtCore import QDir
-
 VERSION = "2.5.1-dev2"
 MINIMUM_LIBOPENSHOT_VERSION = "0.2.5"
 DATE = "20200228000000"
@@ -98,11 +96,18 @@
     print("Loading translations from: {}".format(language_path))
 
 # Compile language list from :/locale resource
-langdir = QDir(language_path)
-langs = langdir.entryList(['OpenShot.*.qm'], QDir.NoDotAndDotDot | QDir.Files,
-                          sort=QDir.Name)
-for trpath in langs:
-    SUPPORTED_LANGUAGES.append(trpath.split('.')[1])
+try:
+    from PyQt5.QtCore import QDir
+    langdir = QDir(language_path)
+    langs = langdir.entryList(
+        ['OpenShot.*.qm'],
+        QDir.NoDotAndDotDot | QDir.Files,
+        sort=QDir.Name)
+    for trpath in langs:
+        SUPPORTED_LANGUAGES.append(trpath.split('.')[1])
+except ImportError:
+    # Fail gracefully if we're running without PyQt5 (e.g. CI tasks)
+    pass
 
 SETUP = {
     "name": NAME,