sphinx2ghpages.yml

name: Sphinx Documentation to GitHub Pages

on:
  push:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"

      - name: Install dependencies (including Sphinx and related)
        run: |
          python -m pip install --upgrade pip
          # Workaround for vam.whittaker installation issue https://github.com/WFP-VAM/vam.whittaker/issues/4
          python -m pip install numpy==1.23.5 cython furo
          python -m pip install .[dev]

      - name: Sphinx build
        run: python -m sphinx -b html docs/source docs/build

      - name: Commit documentation in gh-pages branch
        run: |
          cd docs/build
          git init -b gh-pages
          touch .nojekyll
          git config --local user.name "GitHub Actions Bot"
          git config --local user.email "actions@github.com"
          git add .
          git commit -m "Update documentation"

      - name: Push gh-pages branch
        run: |
          cd docs/build
          git push --force "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}" gh-pages
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}