Merge pull request #49 from kraken-tech/docs-in-ci

Test the docs build in CI

Author: samueljsb

.github/workflows/build_and_publish.yaml

@@ -41,7 +41,7 @@ jobs:
     - name: check changelog includes version
       run: grep '## \[${{ steps.package_version.outputs.version }}\]' < CHANGELOG.md
 
-  publish:
+  pypi:
     runs-on: ubuntu-24.04
     timeout-minutes: 5
 
@@ -58,3 +58,31 @@ jobs:
           name: Packages
           path: dist
       - uses: pypa/gh-action-pypi-publish@release/v1
+
+  docs:
+    runs-on: ubuntu-latest
+
+    needs: [pypi]
+    if: github.repository_owner == 'kraken-tech' && github.ref_type == 'tag'
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v6
+        with:
+          python-version-file: '.github/workflows/.python-version'
+      - name: Install Dependencies
+        run: |
+          pip install --group docs
+      - name: Configure git
+        run: |
+          git config --global user.name "GitHub docs action"
+          git config --global user.email "django-subatomic+docs@example.com"
+      - name: Build Docs Site
+        run: |
+          mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest
+          mike set-default latest --push

.github/workflows/tests.yml

@@ -48,3 +48,15 @@ jobs:
         FORCE_COLOR: "1"
         DEFAULT_DATABASE_URL: postgres://postgres:postgres@localhost/subatomic
         OTHER_DATABASE_URL: postgres://postgres:postgres@localhost/subatomic_other
+
+  docs:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+
+    steps:
+    - uses: actions/checkout@v5
+    - uses: actions/setup-python@v6
+      with:
+        python-version-file: '.github/workflows/.python-version'
+    - run: pip install --group docs
+    - run: mkdocs build --strict

.github/workflows/update-dev-docs.yml

@@ -14,7 +14,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@v6
         with:
-          python-version: 3.13
+          python-version-file: '.github/workflows/.python-version'
       - name: Install Dependencies
         run: |
           pip install --group docs

.github/workflows/update-docs.yml

@@ -25,3 +25,6 @@ uv.lock
 
 # Environment variables
 .env
+
+# Docs build
+site/