Initial version of sphinx documentation and...

- remove ubuntu 21.04 from CI (end of life)
- adjust matrix strategy for clang.yml
- Use lessons learned from RetroArcher on localize.yml, crowdin.yml, and locale.py
- Add end of life comments to Dockerfiles
- Adjust dependency order in Dockerfiles

scripts/Dockerfile-debian

@@ -1,5 +1,7 @@
 FROM debian:bullseye AS sunshine-debian
 
+# Debian Bullseye end of life is TBD
+
 ARG DEBIAN_FRONTEND=noninteractive 
 ARG TZ="Europe/London"
 
@@ -11,9 +13,9 @@ RUN apt-get update -y && \
         cmake \
         git \
         libavdevice-dev \
-        libboost-thread-dev \
         libboost-filesystem-dev \
         libboost-log-dev \
+        libboost-thread-dev \
         libcap-dev \
         libdrm-dev \
         libevdev-dev \

scripts/Dockerfile-fedora_33

@@ -1,5 +1,8 @@
 FROM fedora:33 AS sunshine-fedora_33
 
+# Fedora 33 end of life is November 2021
+# This file remains for reference only
+
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 RUN dnf -y update && \
     dnf -y group install "Development Tools" && \

scripts/Dockerfile-fedora_35

@@ -1,5 +1,7 @@
 FROM fedora:35 AS sunshine-fedora_35
 
+# Fedora 35 end of life is TBD
+
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 RUN dnf -y update && \
     dnf -y group install "Development Tools" && \
@@ -11,8 +13,8 @@ RUN dnf -y update && \
         ffmpeg-devel \
         gcc-c++ \
         libevdev-devel \
-        libxcb-devel \
         libX11-devel \
+        libxcb-devel \
         libXcursor-devel \
         libXfixes-devel \
         libXinerama-devel \

scripts/Dockerfile-ubuntu_18_04

@@ -1,5 +1,7 @@
 FROM ubuntu:18.04 AS sunshine-ubuntu_18_04
 
+# Ubuntu 18.04 end of life is April 2028
+
 ARG DEBIAN_FRONTEND=noninteractive 
 ARG TZ="Europe/London"
 

scripts/Dockerfile-ubuntu_20_04

@@ -1,5 +1,7 @@
 FROM ubuntu:20.04 AS sunshine-ubuntu_20_04
 
+# Ubuntu 20.04 end of life is April 2030
+
 ARG DEBIAN_FRONTEND=noninteractive 
 ARG TZ="Europe/London"
 

scripts/Dockerfile-ubuntu_21_04

@@ -1,5 +1,8 @@
 FROM ubuntu:21.04 AS sunshine-ubuntu_21_04
 
+# Ubuntu 21.04 end of life is January 2022
+# This file remains for reference only
+
 ARG DEBIAN_FRONTEND=noninteractive 
 ARG TZ="Europe/London"
 

scripts/Dockerfile-ubuntu_21_10

@@ -1,5 +1,7 @@
 FROM ubuntu:21.10 AS sunshine-ubuntu_21_10
 
+# Ubuntu 21.10 end of life is July 2022
+
 ARG DEBIAN_FRONTEND=noninteractive 
 ARG TZ="Europe/London"
 
@@ -10,9 +12,9 @@ RUN apt-get update -y && \
         cmake \
         git \
         libavdevice-dev \
-        libboost-thread-dev \
         libboost-filesystem-dev \
         libboost-log-dev \
+        libboost-thread-dev \
         libcap-dev \
         libdrm-dev \
         libevdev-dev \

scripts/_locale.py

@@ -1,4 +1,6 @@
-"""_locale.py
+"""
+..
+   _locale.py
 
 Functions related to building, initializing, updating, and compiling localization translations.
 
@@ -62,7 +64,7 @@ def x_extract():
                 commands.append(filename)
 
     print(commands)
-    proc = subprocess.run(args=commands, cwd=root_dir)
+    subprocess.check_output(args=commands, cwd=root_dir)
 
     # fix header
     body = ""
@@ -98,7 +100,7 @@ def babel_init(locale_code: str):
     ]
 
     print(commands)
-    proc = subprocess.run(args=commands, cwd=root_dir)
+    subprocess.check_output(args=commands, cwd=root_dir)
 
 
 def babel_update():
@@ -113,7 +115,7 @@ def babel_update():
     ]
 
     print(commands)
-    proc = subprocess.run(args=commands, cwd=root_dir)
+    subprocess.check_output(args=commands, cwd=root_dir)
 
 
 def babel_compile():
@@ -126,13 +128,13 @@ def babel_compile():
     ]
 
     print(commands)
-    proc = subprocess.run(args=commands, cwd=root_dir)
+    subprocess.check_output(args=commands, cwd=root_dir)
 
 
 if __name__ == '__main__':
     # Set up and gather command line arguments
     parser = argparse.ArgumentParser(
-        description='Script helps update locale_id translations. Translations must be done manually.')
+        description='Script helps update locale translations. Translations must be done manually.')
 
     parser.add_argument('--extract', action='store_true', help='Extract messages from c++ files.')
     parser.add_argument('--init', action='store_true', help='Initialize any new locales specified in target locales.')

scripts/requirements.txt

@@ -1 +1,4 @@
 Babel==2.9.1
+m2r2==0.3.2
+Sphinx==4.5.0
+sphinx-rtd-theme==1.0.0