docs spec check (canonical#707)

.github/workflows/docs-spelling-checks.yml

@@ -0,0 +1,30 @@
+name: Documentation Spelling Check
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - 'docs/**'
+
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install aspell
+        run: sudo apt-get install aspell aspell-en
+      - id: spell-check
+        name: Spell Check
+        run: make spelling
+        working-directory: docs/tools
+        continue-on-error: true
+      - if: ${{ github.event_name == 'pull_request' && steps.spell-check.outcome == 'failure' }}
+        uses: actions/github-script@v6
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: 'Hi, looks like pyspelling job found some issues, you can check it [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})'
+            })

docs/moonray/.sphinx/requirements.txt

@@ -1,2 +1,3 @@
 git+https://github.com/canonical/canonical-sphinx@main#egg=canonical-sphinx
 sphinx-autobuild
+pyspelling

docs/tools/.custom_wordlist.txt

@@ -0,0 +1,66 @@
+apiserver
+apparmor
+AppArmor
+autostart
+aws
+CAPI
+Ceph
+cgroup
+CIDRS
+CIDRs
+CNI
+config
+containerd
+CoreDNS
+CPUs
+cpuset
+daemonset
+datastore
+dbus
+DNS
+dqlite
+EasyRSA
+etcd
+GCP
+ghcr
+grafana
+html
+http
+https
+initialise
+juju
+kubeconfig
+kubectl
+kubelet
+kubepods
+kubernetes
+libcontainer
+lifecycle
+linux
+localhost
+lxc
+LXD
+MAAS
+Multipass
+nameservers
+NGINX
+OCI
+OpenStack
+proc
+RBAC
+regsync
+roadmap
+Rockcraft
+rw
+snapd
+stackexchange
+sys
+systemd
+TLS
+ubuntu
+unix
+VMs
+VMWare
+VSphere
+www
+yaml

docs/tools/.sphinx/spellingcheck.yaml

@@ -9,7 +9,7 @@ matrix:
     - .custom_wordlist.txt
     output: .sphinx/.wordlist.dic
   sources:
-  - _build/**/*.html
+  - ../_build/**/*.html
   pipeline:
   - pyspelling.filters.html:
       comments: false
@@ -21,7 +21,6 @@ matrix:
       - pre
       - spellexception
       - link
-      - title
       - div.relatedlinks
       - strong.command
       - div.visually-hidden