sphinx-deploy.yml

name: Documentation deployment

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

  # 'workflow_dispatch' allows manual execution of this workflow under the repository's 'Actions' tab
  workflow_dispatch:

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v1
    # Standard drop-in approach that should work for most people
    - uses: ammaraskar/sphinx-action@master
      with:
        docs-folder: "docs/"
    # Create an artifact of the html output
    - uses: actions/upload-artifact@v1
      with:
        name: documentation_html
        path: docs/_build/html/
    # Publish built docs to gh-pages branch
    - name: Commit documentation changes
      run: |
        git clone https://github.com/spacelab-ufsc/spacelab-transmitter.git --branch gh-pages --single-branch gh-pages
        cd gh-pages
        rm -rf *
        rm -f .nojekyll
        rm -f .gitignore
        rm -rf .github/
        cp -r ../docs/_build/html/* .
        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 }}