build-docs.yml

name: Documentation build

on:
  push:
    branches: ["main"]

permissions:
  contents: write

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    env:
      DEBIAN_FRONTEND: "noninteractive"
    steps:
      - name: Install dependencies
        run: |
          sudo apt -qqy update && sudo apt -qqy --no-install-recommends install \
            python3 python3-pip

      - name: Setup repository
        uses: actions/checkout@v4

      - name: Generate VP
        run: |
          export I3C_ROOT_DIR="`pwd`"
          pip3 install git+https://github.com/antmicro/testplanner.git
          REPO_URL="$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/tree/$GITHUB_REF_NAME/" make verification-docs

      - name: Build Docs
        run: |
          pushd doc
            pip3 install -r requirements.txt
            TZ=UTC make html
          popd
          ls -lah doc/build

      - name: Pack artifacts
        if: always()
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: ./doc/build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
            github_token: ${{ secrets.GITHUB_TOKEN }}
            publish_dir: ./doc/build/html