documentation.yaml

name: Documentation

on:
  push:
    branches:
      - main

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - name: Checkout github repo
      uses: actions/checkout@v3
    - name: Lint
      uses: psf/black@stable
    # Standard drop-in approach that should work for most people.
    - name: Build docs
      uses: ammaraskar/sphinx-action@master
      with:
        pre-build-command: "apt-get --allow-releaseinfo-change update -y && apt-get install -y g++ && apt-get install -y gfortran && apt-get install -y pandoc"
        docs-folder: "docs/"
    - name: Checkout pages branch
      uses: actions/checkout@v3
      with:
        ref: gh-pages
        path: gh-pages
    - name: Commit documentation changes
      run: |
        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
        git push