Move sphinx-apidoc command to script and run in CI

.github/workflows/ci.yaml

@@ -188,3 +188,23 @@ jobs:
     with:
       docs-directory: docs/
       pip-install-target: .[dev]
+
+  check-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v5
+
+      - uses: actions/checkout@v4
+
+      - run: pip install .[dev]
+
+      - run: ./devel/generate-developer-api-docs
+
+      - name: Check for changes
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            git add .
+            git diff --staged >&2
+            echo "There are changes to the developer API docs. Please regenerate, commit, and push the changes." >&2
+            exit 1
+          fi

devel/generate-developer-api-docs

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+sphinx-apidoc \
+  --force \
+  --module-first \
+  --separate \
+  --no-toc \
+  --output-dir docs/api/developer \
+  augur

docs/contribute/DEV_DOCS.md

@@ -337,13 +337,7 @@ To update the developer API documentation after adding or removing an augur subm
 autogenerate a new API file as follows.
 
 ```bash
-sphinx-apidoc \
-  --force \
-  --module-first \
-  --separate \
-  --no-toc \
-  --output-dir docs/api/developer \
-  augur
+./devel/generate-developer-api-docs
 ```
 
 To make doc rebuilds faster, Sphinx caches built documentation by default,