doc: add initial documentation setup

.github/workflows/automatic-doc-checks.yml

@@ -0,0 +1,16 @@
+name: Documentation checks
+
+on:
+  - push
+  - pull_request
+  - workflow_dispatch
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  documentation-checks:
+    uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
+    with:
+      working-directory: 'doc'

.github/workflows/builds.yml

@@ -18,11 +18,11 @@ jobs:
         run: make doc
 
       - name: Print warnings
-        run: if [ -s .sphinx/warnings.txt ]; then cat .sphinx/warnings.txt; exit 1; fi
+        run: if [ -s doc/.sphinx/warnings.txt ]; then cat doc/.sphinx/warnings.txt; exit 1; fi
 
       - name: Upload artifacts
         if: always()
         uses: actions/upload-artifact@v4
         with:
           name: documentation
-          path: doc/html
+          path: doc/_build

.github/workflows/tests.yml

@@ -50,35 +50,3 @@ jobs:
 
       - name: Unit tests (all)
         run: make check
-
-  documentation:
-    name: Documentation tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get install aspell aspell-en
-          sudo snap install mdl
-
-      - name: Run markdown linter
-        run: |
-          make doc-lint
-
-      - name: Run spell checker
-        run: |
-          make doc-spellcheck
-
-      - name: Run inclusive naming checker
-        uses: get-woke/woke-action@v0
-        with:
-          fail-on-error: true
-          woke-args: "*.md **/*.md -c https://github.com/canonical-web-and-design/Inclusive-naming/raw/main/config.yml"
-
-      - name: Run link checker
-        # This can fail intermittently due to external resources being unavailable.
-        continue-on-error: true
-        run: |
-          make doc-linkcheck