deploy-docs.yaml

name: Deploy Documentation

on:
  push:
    branches:
      - master

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true
  
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: write
  id-token: write
  pages: write
  
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v4.1.4
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      - name: Install Poetry
        uses: snok/install-poetry@v1

      - name: Install Dependencies
        run: |
          poetry install --no-interaction

      - name: Install dependencies
        # pip will install despite the conflicts, poetry will prevent it
        run: |
          poetry run pip install wheel
          poetry run pip install --no-build-isolation "Cython<3" "pyyaml==5.4.1"
          poetry run pip install sphinx sphinx-rtd-theme

      - name: Setup brownie networks
        run: |
          poetry run brownie networks modify mainnet host=${{ secrets.ALCHEMY_PROVIDER }}
        continue-on-error: true
        
      - name: Build documentation config
        run: |
          make docs

      - name: Build documentation
        run: |
          cd docs
          BROWNIE_NETWORK_ID=mainnet make html

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/_build/html
          
      - name: Checkout
        uses: actions/checkout@v4
        with:
          ref: gh-pages
          persist-credentials: false
          
      - name: Setup Pages
        uses: actions/configure-pages@v4
        
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
          path: '.'
          
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4