docs.yml

name: sphinxdocumentation

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:  
    - name: Checkout code
      uses: actions/checkout@v4
      with:
        fetch-depth: 0 

    - name: Set up Python 
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"


    - name: Install docs dependencies
      run: |
        pip install --upgrade pip
        pip install -e ".[docs]"

    - name: Build docs
      working-directory: ./docs
      run: |
        make html
#      uses: ammaraskar/sphinx-action@master
#      with:
#        docs-folder: "docs/"
         
    # Publish built docs to gh-pages branch.
    # ===============================
    - name: Commit documentation changes
      run: |
        git clone https://github.com/ammaraskar/sphinx-action-test.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 }}
        force: true
    # ===============================