build-sphinx.yml

name: build-sphinx
on:
  push:
    branches:
      - main

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0
        ref: ${{ github.event.pull_request.head.sha }}
    - name: Allow for file ownership conflicts with Docker and GitHub Actions
      run: git config --global --add safe.directory '*'
    - uses: jmduarte/sphinx-action@main
      env:
        SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        pre-build-command: "git config --system --add safe.directory '*'"
        docs-folder: "docs/"
    - name: Commit Documentation Changes
      run: |
        git clone https://github.com/fastmachinelearning/hls4ml.git --branch gh-pages --single-branch gh-pages
        cp -r docs/_build/html/* gh-pages/
        cd gh-pages
        touch .nojekyll
        git config --local user.email "action@github.com"
        git config --local user.name "GitHub Action"
        git add .
        git commit -m "Update Sphinx Documentation" -a || true
    - name: Push Documentation Changes
      uses: ad-m/github-push-action@master
      with:
        branch: gh-pages
        directory: gh-pages
        github_token: ${{ secrets.PERSONAL_TOKEN }}