ci: Check documentation spelling and coverage

jmgate · jmgate · commit e5b3719a6eeb · 2024-07-01T14:15:02.000-06:00
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -47,6 +47,20 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+      - name: Check documentation spelling
+        run: make spelling
+        working-directory: ./doc
+
+      - name: Check documentation coverage
+        run: make coverage
+        working-directory: ./doc
+
+      - name: Archive documentation coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-coverage-report
+          path: doc/build/coverage/python.txt
+
       - name: Test uninstall
         run: python3 -m pip uninstall -y reverse_argparse
 
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -6,3 +6,4 @@ sphinx-copybutton
 sphinx-rtd-theme
 sphinxcontrib-mermaid
 sphinxcontrib-programoutput
+sphinxcontrib-spelling
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -33,6 +33,7 @@
     "sphinx_rtd_theme",
     "sphinxcontrib.mermaid",
     "sphinxcontrib.programoutput",
+    "sphinxcontrib.spelling",
 ]
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
diff --git a/doc/source/spelling_wordlist.txt b/doc/source/spelling_wordlist.txt
@@ -0,0 +1,8 @@
+pre
+erroring
+retryable
+programmatically
+linters
+namespace
+argparse
+ArgumentGroup

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`"sphinx_rtd_theme",`
`34`	`34`	`"sphinxcontrib.mermaid",`
`35`	`35`	`"sphinxcontrib.programoutput",`
	`36`	`+ "sphinxcontrib.spelling",`
`36`	`37`	`]`
`37`	`38`	`intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}`
`38`	`39`