sphinx_build.yml

---
name: "Build documentation"
on:
  workflow_dispatch:
  pull_request:
  push:
    branches:
      - main
  schedule:
    - cron: '38 2 * * *'

jobs:
  docs:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          cache: 'pip'
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install vcstool
      - name: Build documentation (all ROS 2 distros)
        run: |
          mkdir -p doc
          bash scripts/build_docs.sh
      - name: Upload HTML documentation artifact
        if: success()
        uses: actions/upload-artifact@v4
        with:
          name: documentation-html
          path: _build/html
      - name: clone gh-pages branch
        uses: actions/checkout@v4
        if: ${{ success() && github.event_name != 'pull_request' && !env.ACT }}
        with:
          ref: gh-pages
          path: gh-pages
      - name: Deploy Pages
        if: ${{ success() && github.event_name != 'pull_request' && !env.ACT }}
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./_build/html