docs.yml

name: docs

# run on merge to master or manual trigger
on:
  pull_request:
    types: [ closed ]
    paths:
      - 'docs/**/*'
      - 'PyPtt/*.py'
  workflow_dispatch:

jobs:
  build:
    if: github.event_name != 'workflow_dispatch' && github.event.pull_request.merged == true
    name: Build doc and Deploy
    runs-on: ubuntu-latest
    steps:
    - uses: actions/setup-python@v5
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
    - name: Build and Commit
      uses: sphinx-notes/pages@v2
      with:
        requirements_path: docs/requirements.txt
    - name: Push changes
      uses: ad-m/github-push-action@master
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        branch: gh-pages