sphinx.yaml

name: Deploy Sphinx docs

on:
  push:
    branches: [ main ]

  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:   
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Set up Python
        uses: actions/setup-python@v3
        with:
           python-version: "3.10"
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install dependencies
        run: | 
          python -m pip install --upgrade pip
          pip install .
          pip install -r docs/requirements.txt
      - name: Build HTML
        run: | 
          cd docs/
          make html
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: 'docs/_build/html'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2