[build] Add build check to ensure CLI docs are up to date #457

Author: Breakthrough

.github/workflows/generate-docs.yml

@@ -51,6 +51,15 @@ jobs:
           git config --global user.name github-actions
           git config --global user.email github-actions@github.com
 
+      - name: Check CLI Documentation
+        shell: bash
+        run: |
+          if [[ `git status --porcelain=1 | wc -l` -ne 0 ]]; then
+            echo "CLI documentation is of date: docs/cli.rst does not match output after running docs/generate_cli_docs.py!"
+            echo "Re-run `python docs/generate_cli_docs.py` to update and commit the result."
+            exit 1
+          fi
+
       - name: Generate Docs
         run: |
           sphinx-build -b html docs build

docs/cli.rst

@@ -1,3 +1,4 @@
+.. NOTE: This file is auto-generated by docs/generate_cli_docs.py and should not be modified.
 
 ************************************************************************
 ``scenedetect`` 🎬 Command

docs/generate_cli_docs.py

@@ -267,6 +267,7 @@ def create_help() -> ty.Tuple[str, ty.List[str]]:
 def main():
     help, commands = create_help()
     help = patch_help(help, commands)
+    help = ".. NOTE: This file is auto-generated by docs/generate_cli_docs.py and should not be modified.\n" + help
     with open("docs/cli.rst", "wb") as f:
         f.write(help.encode())