build-and-deploy-docs.yml

name: docs/gh-pages
on: [workflow_dispatch]
  # create:
  #   tags:
  #     - '*'
  # schedule:
  #   - cron: '0 3 * * *' # run every night at 3AM

jobs:
    build-docs:
        name: Build docs and push to gh-pages
        runs-on: ubuntu-latest
        steps:
            - name: Checkout branch
              uses: actions/checkout@v2

            - name: Setup python 
              uses: actions/setup-python@master
              with:
                python-version: 3.8
            
            - name: Install poetry
              uses: snok/install-poetry@v1
              with:
                virtualenvs-create: true
            
            - name: Install dependencies
              run: poetry install
            
            - name: build docs
              run: |
                source $(poetry env info --path)/bin/activate
                cd docs
                make clean
                make html
                cd ..
            
            - name: deploy to gh-pages
              uses: Cecilapp/GitHub-Pages-deploy@v3
              env:
                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
              with:
                email: david.hagan@quant-aq.com
                build_dir: docs/_build/html