sphinx-docgen.yml

name: GitHub Pages

on:
  push:
    branches: ["main"]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "github-pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          submodules: recursive

      - name: Setup Pages
        uses: actions/configure-pages@v2
      - uses: actions/setup-python@v2

      - name: Yarn install
        run: |
          yarn install --production

      - name: Install Python requirements and SOLC
        run: |
          pip install --upgrade pip
          pip install -r site/requirements.txt

      - name: Install solc 0.8.19
        run: |
          pip install solc-select
          solc-select install 0.8.19

      - name: Sphinx Gendoc
        env:
          SOLC_VERSION: 0.8.19
        run: |
          bin/gendoc.sh
          sphinx-build -b html site ./_site

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1