docs: Integrate Aliro docs with Zoomin

- Add publish_documentation.yaml workflow for building and publishing docs to Zoomin.
- Add on_push_publish_documentation.yaml to auto-publish on docs changes to main.
- Add on_push_tag.yaml to publish release docs on version tags.
- Add generate_docs.sh script for Sphinx-based doc generation.
- Add custom.properties and tags.yml for Zoomin metadata.

Signed-off-by: Konrad Grucel <konrad.grucel@nordicsemi.no>

Author: kg-nordicsemi

.github/workflows/on_push_publish_documentation.yaml

@@ -0,0 +1,20 @@
+name: Publish latest documentation
+
+on:
+  workflow_dispatch:
+
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+jobs:
+  deploy:
+    uses: ./.github/workflows/publish_documentation.yaml
+    with:
+      documentation_tag: "latest"
+      publish_to_prod: true
+      publish_to_dev: true
+    secrets:
+      NCS_ZOOMIN_KEY: ${{ secrets.NCS_ZOOMIN_KEY }}

.github/workflows/on_push_tag.yaml

@@ -0,0 +1,16 @@
+name: Publish release documentation
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+*'
+
+jobs:
+  build_documentation:
+    uses: ./.github/workflows/publish_documentation.yaml
+    secrets:
+      NCS_ZOOMIN_KEY: ${{ secrets.NCS_ZOOMIN_KEY }}
+    with:
+      documentation_tag: ${{ github.ref_name }}
+      publish_to_prod: true
+      publish_to_dev: true

.github/workflows/publish_documentation.yaml

@@ -0,0 +1,102 @@
+name: Publish documentation
+
+on:
+  workflow_dispatch:
+    inputs:
+      documentation_tag:
+        type: string
+        required: false
+        default: "latest"
+        description: "Label of the documentation"
+      publish_to_prod:
+        type: boolean
+        default: true
+      publish_to_dev:
+        type: boolean
+        default: true
+
+  workflow_call:
+    inputs:
+      documentation_tag:
+        type: string
+        required: true
+        default: "latest"
+      publish_to_prod:
+        type: boolean
+        default: true
+      publish_to_dev:
+        type: boolean
+        default: true
+    secrets:
+      NCS_ZOOMIN_KEY:
+        required: true
+
+jobs:
+  Publish_Documentation:
+    env:
+      DOCS_DIR: docs
+      DOC_TAG: ${{ inputs.documentation_tag }}
+
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Build documentation
+        env:
+          ARCHIVE: "addon-aliro_${{ env.DOC_TAG }}.zip"
+        run: |
+          cd ${{env.DOCS_DIR}}
+          ./generate_docs.sh
+
+          cp custom.properties build/html/
+          sed -i "s/__VERSION__/${DOC_TAG}/g" build/html/custom.properties
+
+          cp tags.yml build/html/
+          sed -i "s/__VERSION__/${DOC_TAG}/g" build/html/tags.yml
+
+          cd build/html
+          zip -rq "${ARCHIVE}" .
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: ${{env.DOCS_DIR}}/build/html/addon-aliro_${{ env.DOC_TAG }}.zip
+
+      - name: Prepare Key
+        env:
+          NCS_ZOOMIN_KEY: ${{ secrets.NCS_ZOOMIN_KEY }}
+        run: |
+          mkdir -p ~/.ssh
+          ssh-keyscan ${{ vars.NCS_ZOOMIN_SERVER }} >> ~/.ssh/known_hosts
+          echo "$NCS_ZOOMIN_KEY" > zoomin_key
+          chmod 600 zoomin_key
+
+      - name: Publish documentation - dev
+        if: ${{ inputs.publish_to_dev }}
+        env:
+          ARCHIVE: "addon-aliro_${{ env.DOC_TAG }}.zip"
+        run: |
+          sftp -v -i zoomin_key ${{vars.NCS_ZOOMIN_USER}}@${{ vars.NCS_ZOOMIN_SERVER }} <<EOF
+            cd ${{ vars.NCS_ZOOMIN_DEPLOY_DEV_PATH}}
+            put ${{env.DOCS_DIR}}/build/html/${ARCHIVE}
+          EOF
+
+      - name: Publish documentation - prod
+        if: ${{ inputs.publish_to_prod }}
+        env:
+          ARCHIVE: "addon-aliro_${{ env.DOC_TAG }}.zip"
+        run: |
+          sftp -v -i zoomin_key ${{vars.NCS_ZOOMIN_USER}}@${{ vars.NCS_ZOOMIN_SERVER }} <<EOF
+            cd ${{ vars.NCS_ZOOMIN_DEPLOY_PROD_PATH}}
+            put ${{env.DOCS_DIR}}/build/html/${ARCHIVE}
+          EOF

docs/custom.properties

@@ -0,0 +1,2 @@
+manual.name=addon-aliro-__VERSION__
+booktitle=nRF Door Lock and Access Control Add-on __VERSION__

docs/generate_docs.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+cd "$SCRIPT_DIR"
+
+python3 -m venv .venv
+source ./.venv/bin/activate
+
+pip install -r requirements.txt
+
+sphinx-build -M html . build

docs/tags.yml

@@ -0,0 +1,9 @@
+# Document tags for Zoomin.
+
+# Tags for all topics:
+mapping_global:
+  - addon-aliro-__VERSION__
+  - cluster-addon-aliro-__VERSION__
+
+# Tags for individual topics:
+mapping_topics: