docs.yml

name: Build documentation

on:
    push:
        branches: [master]

    # Allows you to run this workflow manually from the Actions tab
    workflow_dispatch:

jobs:
    # This workflow contains a single job called "build"
    build:
        # The type of runner that the job will run on
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v4
              with:
                  fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
            - name: Install dependencies
              run: |
                  sudo apt-get update;
                  sudo apt-get install pandoc
            - name: Build and Commit
              uses: sphinx-notes/pages@v2
              with:
                  requirements_path: doc/requirements.txt
                  documentation_path: doc/source
                  target_path: latest
            - name: Push changes
              uses: ad-m/github-push-action@master
              with:
                  github_token: ${{ secrets.GITHUB_TOKEN }}
                  branch: gh-pages