docs_build_and_publish.yml

name: docs
on:
  release:
    types: [published]
  push:
    branches: [ master ]
    tags:
      - '**'
  pull_request:
    branches: [ master ]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - uses: ammaraskar/sphinx-action@master
      with:
        docs-folder: "docs/"
        pre-build-command: python -m pip install --upgrade pip; pip install sphinx_rtd_theme
    # Create an artifact of the html output.
    - uses: actions/upload-artifact@v4
      with:
        name: DocumentationHTML
        path: docs/build/html/
  
  publish:
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/master'
    steps:
    - name: Download artifact of the html output.
      uses: actions/download-artifact@v4
      with:
        name: DocumentationHTML
        path: docs/build/html/
    - name: Commit documentation changes
      run: |
        git clone https://github.com/TomographicImaging/iDVC.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 documentation" -a || true
        # The above command will fail if no changes were present, so we ignore
        # that.
    - name: Push changes
      uses: ad-m/github-push-action@master
      with:
        branch: gh-pages
        directory: gh-pages
        github_token: ${{ secrets.GITHUB_TOKEN }}