pages.yml

name: Sphinx docs to gh-pages

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  build-docs:
    runs-on: ubuntu-latest
    name: Sphinx docs to gh-pages
    steps:
      - uses: actions/checkout@v3
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'
          cache: "pip"
          cache-dependency-path: pyproject.toml
      - name: Installing the library
        shell: bash -l {0}
        run: |
          make dev
      - name: make docs
        run: |
          make docs
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: "./docs/_build/html/"
  deploy-docs:
    needs: build-docs
    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1